From 45589d2588011842bf84f64842d974ef3059d8e1 Mon Sep 17 00:00:00 2001 From: sagargulabani Date: Thu, 7 May 2026 13:58:34 +0530 Subject: [PATCH] [ENG-41339] Add docs/ scaffold and CLAUDE.md with documentation upkeep convention MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- CLAUDE.md | 17 +++++++++++++++++ docs/.gitkeep | 0 docs/getting-started.md | 17 +++++++++++++++++ docs/index.md | 16 ++++++++++++++++ docs/overview.md | 14 ++++++++++++++ 5 files changed, 64 insertions(+) create mode 100644 CLAUDE.md create mode 100644 docs/.gitkeep create mode 100644 docs/getting-started.md create mode 100644 docs/index.md create mode 100644 docs/overview.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 00000000..5d117f88 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,17 @@ +# LakeView — Claude Context + +## Project Overview + +`LakeView` is a OneHouse component for surfacing lakehouse-table observability — table metadata, partition health, ingestion progress, and similar visibility into Hudi/Iceberg tables managed by OneHouse. + +## Documentation + +All conceptual / architectural / operational docs live in `docs/`. See [`docs/index.md`](docs/index.md) for the index. + +This repo's `docs/` folder is mounted into the OneHouse AI agent platform via git-sync and indexed into QMD as the `lakeview-docs` collection — so well-written docs here are directly consumed by RCA, Scoping, and other agents. + +## Coding Principles + +- **Document everything.** Every new feature, integration, or significant change MUST have corresponding documentation in `docs/`. Create a new doc file if no existing doc covers the topic. Always keep docs in sync with code — documentation is not optional. + +- When opening a PR or pushing a commit that touches behaviour, also update the relevant doc under `docs/`. If your change affects architecture, deployment, or configuration, expand or rewrite the corresponding section. If you add a new module or component, add a doc for it. diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 00000000..0206ebb7 --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,17 @@ +# Getting Started + +> **Stub.** Engineers will fill this in. + +See the existing root-level [README.md](../README.md) for current build/run instructions; this file should grow into a curated developer onboarding guide. + +## Prerequisites + +> Java/Gradle versions, OneHouse credentials, cloud-storage account access, etc. + +## Local Setup + +> Clone, configure, build, run. + +## Common tasks + +> One-liners for the most common dev workflows. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..3318930d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,16 @@ +# LakeView Documentation + +This directory holds conceptual / architectural / operational documentation for the `LakeView` repo. Code-level docstrings live in source files; long-form explanation lives here. + +## Index + +- [overview.md](overview.md) — what this repo does and where it fits in the OneHouse stack +- [getting-started.md](getting-started.md) — local development setup + +## Adding a doc + +Drop a new `.md` here and link it in this index. + +## Indexing automation + +This repo's `docs/` folder is mounted into the OneHouse AI agent platform via git-sync and indexed into QMD as the `lakeview-docs` collection. After landing a doc change on `main`, trigger the [reindex workflow](https://github.com/onehouseinc/knowledge-base/actions/workflows/reindex-qmd.yml) or wait up to an hour for the next git-sync tick. diff --git a/docs/overview.md b/docs/overview.md new file mode 100644 index 00000000..bd73ac7c --- /dev/null +++ b/docs/overview.md @@ -0,0 +1,14 @@ +# LakeView — Overview + +> **Stub.** Engineers will fill this in. + +`LakeView` is a OneHouse component for surfacing lakehouse-table observability — table metadata, partition health, ingestion progress, and similar visibility into Hudi/Iceberg tables managed by OneHouse. + +## Components + +> List key components / modules — typical entries: storage clients (S3/GCS/Azure), metadata extractors, REST/gRPC API layer. + +## Related repos + +- `onehouse-dataplane` — produces the table state LakeView surfaces +- `gateway-controller` — control-plane counterpart that LakeView interacts with