Shorten the "Codebase wiki" starter-pack description to a single short…#353
Merged
Conversation
…nce (#2220) * docs: serve per-page raw markdown (.md route) + Copy Markdown affordance For a "markdown KB your agents can read," the docs site only offered whole-corpus consumption (llms.txt / llms-full.txt). An agent wanting a single page had to parse ~147 KB of RSC HTML or download the whole ~153 KB corpus. This adds the missing per-page affordance. - New `…/<slug>.md` (and `.mdx`) endpoint returning `text/markdown`: next.config `beforeFiles` rewrite maps `/docs/<slug>.md` → `/llms.mdx/<slug>`, a statically-generated route handler that mirrors the OG route shape. Verified live: all 21 doc pages return 200 text/markdown. - Shared `getLLMText(page)` helper; `llms-full.txt` refactored onto it (output byte-identical) so the corpus and per-page views never drift. - `PageMarkdownActions` client component on every doc page: "Copy Markdown" split button + dropdown (View as Markdown / Open in ChatGPT / Open in Claude), styled with Fumadocs `fd-*` tokens. Claude-Session: https://claude.ai/code/session_01YCdL6c9SAak7B6cKvLYRpT * chore(docs): fix pre-existing biome format drift in overview-blocks Whole-tree pre-push biome check flagged an unwrapped long line in this file (drift predating this branch). Mechanical `biome format` line-wrap; no rendered-text change. Unblocks the push. Claude-Session: https://claude.ai/code/session_01YCdL6c9SAak7B6cKvLYRpT * a11y(docs): visible keyboard focus on markdown actions + decorative icon The split control sits in an `overflow-hidden` container, which clips a default focus ring, and the dropdown trigger suppressed its outline with no replacement. Add `focus-visible:bg-fd-accent` to both controls so keyboard focus is visible within the clip. Mark the Claude brand icon `aria-hidden` (the "Open in Claude" label is the accessible name), matching the decorative ChatGPT badge. Claude-Session: https://claude.ai/code/session_01YCdL6c9SAak7B6cKvLYRpT * docs: address review — dynamic copy aria-label, distinct focus ring, test contract Review feedback (both bots: approve-with-suggestions, mergeable as-is): - Copy button `aria-label` now reflects the copied state ("Copied" vs "Copy this page as Markdown") so screen readers announce the transition, not just the visible label. - Keyboard focus is now a distinct inset ring (`focus-visible:ring`) rather than reusing the hover fill, so focus and hover are visually distinguishable on both the button and the dropdown trigger. Inset so it shows within the `overflow-hidden` container. - Reframe the `generateStaticParams` test from echoing the mock's exact return (a mock-tautology) to asserting the contract it owes: a non-empty list of `{ slug: string[] }`. Claude-Session: https://claude.ai/code/session_01YCdL6c9SAak7B6cKvLYRpT * feat(docs): point llms.txt links at per-page .md for agent discovery llms.txt previously linked to the HTML page URLs, so an agent following the well-known index landed on the RSC HTML shell, not the clean Markdown this feature adds. Append `.md` to each link so the index now hands agents the per-page Markdown directly — closing the autonomous-discovery loop (no UI, no guessing the `.md` convention). Served by the same `…/<slug>.md` rewrite → /llms.mdx/[...slug] route. Claude-Session: https://claude.ai/code/session_01YCdL6c9SAak7B6cKvLYRpT * docs(ui): restyle markdown actions as compact control inline with title The affordance read as a heavy default-shadcn CTA floating in its own block under the description. Restyle to a compact outline split control (thin border, xs, muted, no fill/shadow) and move it inline to the top-right of the page-title row, so it reads as a page utility rather than a content block. Label shortened to "Copy page" (the dropdown still clarifies Markdown). The control now owns only its visual style; the call site passes positioning via `className`. Claude-Session: https://claude.ai/code/session_01YCdL6c9SAak7B6cKvLYRpT * chore(seed): shorten Codebase wiki pack description to match siblings The "Codebase wiki" starter-pack card carried a ~280-char paragraph while every sibling pack is a single short clause, so it overflowed the "Initialize a starter pack" picker. Shorten to "Architecture, modules, and flows." (33 chars) — parallel to Software lifecycle's "Proposals, decisions, and specs." Only the description string changes; no test pins it and PackCardGrid renders it as data. Claude-Session: https://claude.ai/code/session_01YCdL6c9SAak7B6cKvLYRpT --------- GitOrigin-RevId: 668697b6e85e64b8d6542d1e9a7422c62d72174b
Contributor
There was a problem hiding this comment.
Automated approval from agents-private public-mirror-sync (run: https://github.com/inkeep/agents-private/actions/runs/28303755962). Source of truth is the monorepo; direct edits on inkeep/open-knowledge are overwritten on next sync.
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.
Shorten the "Codebase wiki" starter-pack description to a single short clause ("Architecture, modules, and flows.") so its card matches the length of the other packs on the starter-pack picker instead of overflowing with a full paragraph.