Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -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.
Empty file added docs/.gitkeep
Empty file.
17 changes: 17 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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 `<topic>.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.
14 changes: 14 additions & 0 deletions docs/overview.md
Original file line number Diff line number Diff line change
@@ -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
Loading