feat(wiki): add full in-app wiki browser and llms index#80
Conversation
![baz-reviewer[bot]](https://avatars.githubusercontent.com/in/933528?s=60&v=4){kind=small}
| const sanitizeHref = (href: string): string | null => { | ||
| const trimmed = href.trim(); | ||
| if (!trimmed) return null; | ||
| if (trimmed.startsWith('//')) return null; | ||
|
|
There was a problem hiding this comment.
The trimming/scheme-validation flow inside sanitizeHref and the nearly identical sanitizeImageSrc in pages/WikiBrowser.tsx are duplicated except for the allowed-schemes set, so scheme changes now require two edits and link/image sanitization can drift—can we extract a shared sanitizeByAllowedSchemes(value, schemes) helper and drive both components through it?
Finding type: Code Dedup and Conventions
- Apply fix with Baz
There was a problem hiding this comment.
Commit c899970 addressed this comment by updating the GitHub Pages deployment workflow in .github/workflows/deploy-pages.yml and adding a new .github/workflows/pages-verify.yml workflow for Pages verification.
There was a problem hiding this comment.
nope it didnt fix it. but we're going to pass on this anyway its petty refactor not in scope
There was a problem hiding this comment.
Understood, we’ll skip this refactor as it’s out of scope for now—I'll remember this preference after the PR is merged.
1 participant
User description
Opener Type
Summary
Changes Made
Related Issues
Type of Change
Testing
Checklist
Generated description
Below is a concise technical summary of the changes proposed in this PR:
graph LR Route_wiki_("Route /wiki/*"):::added WikiBrowser_("WikiBrowser"):::added WIKI_DOC_MAP_("WIKI_DOC_MAP"):::added WIKI_ASSET_MAP_("WIKI_ASSET_MAP"):::added defaultMarkdownComponents_("defaultMarkdownComponents"):::added SkillDetail_("SkillDetail"):::modified Header_("Header"):::modified Route_wiki_ -- "Adds route rendering WikiBrowser for /wiki/*" --> WikiBrowser_ WikiBrowser_ -- "Builds slug-to-doc map from markdown files" --> WIKI_DOC_MAP_ WikiBrowser_ -- "Indexes wiki assets to resolve relative image/link URLs" --> WIKI_ASSET_MAP_ WikiBrowser_ -- "Uses shared markdown components for consistent rendering" --> defaultMarkdownComponents_ SkillDetail_ -- "Switches to shared defaultMarkdownComponents for skill docs" --> defaultMarkdownComponents_ Header_ -- "Adds 'Wiki' nav link pointing to /wiki route" --> Route_wiki_ classDef added stroke:#15AA7A classDef removed stroke:#CD5270 classDef modified stroke:#EDAC4C linkStyle default stroke:#CBD5E1,font-size:13pxIntegrates a full in-app Wiki browser, allowing users to navigate repository documentation directly within the application UI. Establishes an automated system for generating LLM-ready
llms.txtexports from markdown files and updates CI/CD pipelines to validate and deploy these new wiki assets.Modified files (7)
Latest Contributors(2)
pages-verify.yml) for validating wiki builds on pull requests and refines the main deployment workflow (deploy-pages.yml) to ensure proper production deployment. Additionally, migrates existing operational documentation from thedocs/directory into the newwiki/structure and updates internal references.Modified files (19)
Latest Contributors(2)