docs(kb): add folder organization and frontmatter guidance to KB CLAUDE.md #757
Merged
docs(kb): add folder organization and frontmatter guidance to KB CLAUDE.md #757
Conversation
- covers placing new articles in product folders vs. category subfolders - covers moving articles within the same product folder - covers moving articles to a different product folder (images + frontmatter) - covers creating new category folders with _category_.json - notes to update incoming reference links when moving to avoid build errors
- add Frontmatter section with all required fields inline; calls out mandatory kb tag explicitly so it's always in context - add category tag update step to both move scenarios - add note that only canonical docs/kb/ sources need link updates; versioned copies are regenerated by the build script - add cross-product move step to review article body for old product name references - add local testing note: kb:clean required after moves, not just restart
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
docs/kb/CLAUDE.mdcovering how to place, move, and categorize KB articleskbtagChanges
Folder Organization section (
docs/kb/CLAUDE.md):productsfrontmatter update, category tag update, and body text review for old product name references_category_.jsondocs/kb/sources need reference link updates — versioned copies underdocs/<product>/<version>/kb/are regenerated by the build scriptnpm run kb:clean && npm run startrequired after moves, not just a dev server restartkb_style_guide.mdkbmust be present intagsfor every KB article for Algolia search filteringTesting
Ran 4 scenarios on a throwaway
test/kb-guidance-scenariosbranch against real repo files:Scenario 1 — Add to existing category folder
test-article-scenario-1.mdinaccessanalyzer/troubleshooting-and-errors/kbtag gap in CLAUDE.md caused it to be omitted from the test article — led to adding the Frontmatter sectionScenario 2 — Move within the same product folder
error-removed-host-name-in-aic-andor-fsaa-host-table.mdfromaccessanalyzer/troubleshooting-and-errors/toaccessanalyzer/file-system-and-sensitive-data-discovery/dropping_file_system_data.mddocs/accessanalyzer/12.0/kb/and11.6/kb/do not need manual updatestroubleshooting-and-errors) needing update to match destination folder — led to adding the category tag step to both move scenariosScenario 3 — Move to a different product folder
password-never-expires-report-shows-incorrect-data.mdfrom1secure/troubleshooting/toprivilegesecure/troubleshooting-and-errors/productsfromonesecuretoprivilege-secure-access-managementtroubleshootingtotroubleshooting-and-errorsScenario 4 — Create new category folder with image-heavy article
troubleshooting-and-errors/subfolder underpingcastle/, added_category_.jsonscheduler-or-agent-deployment-returns-401-unauthorized-error.md(5 images) into the new folder0-images/filename.png) remained valid without edits — no path updates needed when images move with the articleDev server test
npm run kb:clean && npm run startafter all moveskb:clean— led to adding the local testing noteBuild test
npm run build— clean build, no broken links or errors