Skip to content

Move root documentation into docs tree#380

Merged
aaltshuler merged 1 commit into
mainfrom
codex/organize-root-docs
Jul 21, 2026
Merged

Move root documentation into docs tree#380
aaltshuler merged 1 commit into
mainfrom
codex/organize-root-docs

Conversation

@aaltshuler

@aaltshuler aaltshuler commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • move the tracked RFC-026 supporting notes from the repository root into docs/dev
  • normalize WAL-thinking.md to lowercase kebab-case and repair all relative links
  • index the supporting analysis from the developer docs entry point
  • place the v0.8.1 community announcement alongside release notes
  • keep conventional repository discovery and governance documents at the root

Why

The repository root should contain project entry points and control files. Design analysis belongs in the developer documentation taxonomy, while release-specific communication belongs with release history.

Validation

  • scripts/check-agents-md.sh
  • git diff --check
  • verified all moved-document relative targets exist

Dependency

Stacked on #379 because two of the moved WAL documents are introduced there. Retarget this PR to main after #379 merges.

Greptile Summary

This PR organizes design and release documentation under the existing docs tree. The main changes are:

  • Moves RFC-026 supporting notes into docs/dev.
  • Renames the WAL notes to lowercase kebab-case.
  • Repairs relative links in the moved documents.
  • Adds the supporting analysis to the developer docs index.
  • Places the v0.8.1 community announcement under docs/releases.

Confidence Score: 5/5

This looks safe to merge.

  • The previously broken Slack-style links now use standard Markdown syntax.
  • No incomplete or unsafe fix remains in the changed documentation.

Important Files Changed

Filename Overview
docs/dev/index.md Adds an index entry for the relocated RFC-026 supporting analysis.
docs/dev/lance-memwal-pr.md Moves the Lance MemWAL proposal into developer docs and updates its relative links.
docs/dev/wal-options.md Moves the WAL options analysis into developer docs and repairs internal links.
docs/dev/wal-thinking.md Moves and renames the WAL notes while updating links to RFCs and test files.
docs/releases/v0.8.1-community.md Adds the v0.8.1 community announcement with standard Markdown links.

Reviews (2): Last reviewed commit: "Move root documentation into docs tree" | Re-trigger Greptile

Context used:

  • Context used - AGENTS.md (source)
  • Context used - CLAUDE.md (source)

Comment thread docs/releases/v0.8.1-community.md Outdated
@aaltshuler
aaltshuler force-pushed the codex/organize-root-docs branch from 272d57b to f591631 Compare July 21, 2026 12:13
@aaltshuler
aaltshuler changed the base branch from codex/rfc026-b2a-retain-all-gate-r0 to main July 21, 2026 12:13
@aaltshuler
aaltshuler force-pushed the codex/organize-root-docs branch from f591631 to e389e1c Compare July 21, 2026 12:14
@aaltshuler
aaltshuler merged commit 9aa2ed1 into main Jul 21, 2026
7 checks passed
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