docs(blog): document Notra post mapping, visibility rules, and troubleshooting#112
Closed
tembo[bot] wants to merge 1 commit into
Closed
docs(blog): document Notra post mapping, visibility rules, and troubleshooting#112tembo[bot] wants to merge 1 commit into
tembo[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Requesting review from @leoisadev1 who has experience with the following files modified in this PR:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Member
|
Closing: the still-accurate content here (field-mapping table, visibility rules, CSP note) was folded into #121 and re-verified against the current SSR architecture. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up documentation for the Notra-backed blog landed in #110. That PR added a high-level "Blog content (Notra)" section to
apps/fumadocs/README.mdcovering the build-time fetch pipeline, theNOTRA_API_KEYenv var, and the weekly refresh workflow — but the post-mapping/authoring contract, visibility rules, CSP requirement for post images, and troubleshooting were undocumented. This PR fills that gap by expanding the existing section (no new page), verified against source.Docs added/updated
apps/fumadocs/README.md— extended the existing Blog content (Notra) section with four scannable subsections:BlogPostshape (slug always re-slugified + deduped, title required, description from first paragraph, dates fromcreatedAt/updatedAt, read time at 200 wpm, derived OG image, tags always empty) plus the Markdown→sanitized-HTML rules (leading# Titlestripped, allowlisted tags, external-link/image attributes, allowed URL schemes).img-src https://*.usenotra.comallowance invercel.jsonand what to do if the image host changes.bun run posts:fetch, and CSP image failures.Codepaths covered
apps/fumadocs/scripts/notra-content.ts—mapNotraPost,slugify/dedupeSlug,excerptFromMarkdown,estimateReadTime,stripLeadingH1,renderMarkdownToSafeHtml(sanitize-html allowlist, link/image transforms).apps/fumadocs/scripts/fetch-notra-posts.ts— published-only fetch, snapshot fallback whenNOTRA_API_KEYis unset,[notra]log line.apps/fumadocs/src/lib/blog.ts+blog-types.ts—BlogPostshape and theisBlogPostPublished/ future-date filtering.apps/fumadocs/src/routes/blog/$slug.tsx&index.tsx— direct-URL reachability viaincludeFuture, empty-body and "No posts yet" states.vercel.json—Content-Security-Policyimg-srcallowance for Notra-hosted images.Key knowledge gaps addressed
createdAthides a post from the index but leaves it shareable by URL.Validation
Documentation-only change to a single Markdown file; no code, build, or test impact.
Documentation automation — triggered by the merge of #110.