[ENG-41339] Add docs/ scaffold + CLAUDE.md with documentation upkeep convention#188
Merged
Merged
Conversation
…p convention Bootstraps the docs/ folder and adds a CLAUDE.md for the OneHouse AI agent platform's QMD-indexing pipeline. The docs/ folder is git-synced into agent pods and indexed as the lakeview-docs QMD collection — engineers will fill in real content over time; this PR ships only the scaffolding. - CLAUDE.md - project overview + documentation upkeep convention - docs/index.md - per-repo doc index - docs/overview.md - stub - docs/getting-started.md- stub - docs/.gitkeep - placeholder
|
dharmendersheshma
approved these changes
May 11, 2026
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
3 participants
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
Why
The OneHouse AI agent platform git-syncs every repo and indexes each repo's `docs/` folder into QMD as a per-repo collection (`lakeview-docs`). For the agent's `query` MCP to return useful hits about LakeView, this repo needs a top-level `docs/` to land into. This PR ships the scaffolding so the collection registers non-empty; engineers will fill in real content over time.
The CLAUDE.md upkeep convention codifies "document everything in `docs/`" — same convention being applied across the full OneHouse repo set under ENG-41339.
Files
Companion work
This PR is one of several under ENG-41339 across OneHouse repos that all add the same `docs/` + CLAUDE.md scaffold. Once these land, the QMD reindex pipeline (in knowledge-base/.github/workflows/reindex-qmd.yml) picks them up and exposes them to the RCA / Scoping agents.
Test plan