Skip to content

docs(kb): add folder organization and frontmatter guidance to KB CLAUDE.md #757

Merged
hilram7 merged 2 commits intodevfrom
update/kb-claude-md-folder-guidance
Apr 14, 2026
Merged

docs(kb): add folder organization and frontmatter guidance to KB CLAUDE.md #757
hilram7 merged 2 commits intodevfrom
update/kb-claude-md-folder-guidance

Conversation

@hilram7
Copy link
Copy Markdown
Collaborator

@hilram7 hilram7 commented Apr 14, 2026

Summary

  • Added a Folder Organization section to docs/kb/CLAUDE.md covering how to place, move, and categorize KB articles
  • Added a Frontmatter section surfacing all required fields inline, with an explicit callout for the mandatory kb tag
  • Filled in gaps discovered during structured scenario testing

Changes

Folder Organization section (docs/kb/CLAUDE.md):

  • Guidance for placing new articles in product folders vs. category subfolders
  • Step-by-step instructions for moving articles within the same product folder
  • Step-by-step instructions for moving articles to a different product folder, including products frontmatter update, category tag update, and body text review for old product name references
  • Instructions for creating new category folders with _category_.json
  • Note that only canonical docs/kb/ sources need reference link updates — versioned copies under docs/<product>/<version>/kb/ are regenerated by the build script
  • Local testing note: npm run kb:clean && npm run start required after moves, not just a dev server restart
  • Inline table of all required frontmatter fields so rules are always in active context, not buried in kb_style_guide.md
  • Explicit callout that kb must be present in tags for every KB article for Algolia search filtering

Testing

Ran 4 scenarios on a throwaway test/kb-guidance-scenarios branch against real repo files:

Scenario 1 — Add to existing category folder

  • Created test-article-scenario-1.md in accessanalyzer/troubleshooting-and-errors/
  • Confirmed correct folder placement
  • Identified that the kb tag gap in CLAUDE.md caused it to be omitted from the test article — led to adding the Frontmatter section

Scenario 2 — Move within the same product folder

  • Moved error-removed-host-name-in-aic-andor-fsaa-host-table.md from accessanalyzer/troubleshooting-and-errors/ to accessanalyzer/file-system-and-sensitive-data-discovery/
  • Grepped for incoming links — found and updated 2 references in dropping_file_system_data.md
  • Confirmed versioned copies in docs/accessanalyzer/12.0/kb/ and 11.6/kb/ do not need manual updates
  • Caught stale category tag (troubleshooting-and-errors) needing update to match destination folder — led to adding the category tag step to both move scenarios

Scenario 3 — Move to a different product folder

  • Moved password-never-expires-report-shows-incorrect-data.md from 1secure/troubleshooting/ to privilegesecure/troubleshooting-and-errors/
  • Updated products from onesecure to privilege-secure-access-management
  • Updated category tag from troubleshooting to troubleshooting-and-errors
  • Confirmed no incoming reference links
  • Identified article body still referenced old product name — led to adding the body text review step for cross-product moves

Scenario 4 — Create new category folder with image-heavy article

  • Created troubleshooting-and-errors/ subfolder under pingcastle/, added _category_.json
  • Moved scheduler-or-agent-deployment-returns-401-unauthorized-error.md (5 images) into the new folder
  • Confirmed all 5 images moved correctly alongside the article
  • Confirmed relative image path references (0-images/filename.png) remained valid without edits — no path updates needed when images move with the article

Dev server test

  • Ran npm run kb:clean && npm run start after all moves
  • Confirmed all new paths resolved correctly in the dev server
  • Confirmed stale versioned copies persist when using plain restart without kb:clean — led to adding the local testing note

Build test

  • Ran npm run build — clean build, no broken links or errors

hilram7 added 2 commits April 14, 2026 13:17
- 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
@hilram7 hilram7 requested a review from a team as a code owner April 14, 2026 18:45
@hilram7 hilram7 merged commit 811063f into dev Apr 14, 2026
5 checks passed
@hilram7 hilram7 deleted the update/kb-claude-md-folder-guidance branch April 14, 2026 18:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant