Skip to content

Commit 820f463

Browse files
committed
docs: add research README and simplify docs index hierarchy
Each docs subdirectory now owns its own README index, matching the pattern guide/ already followed. The top-level docs/README.md points to subdirectories instead of reaching through to individual files.
1 parent b6b3420 commit 820f463

2 files changed

Lines changed: 16 additions & 14 deletions

File tree

docs/README.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
1-
# Documentation Index
1+
# Documentation
22

3-
## User Guide
3+
## Contents
44

5-
See [`guide/`](guide/) for user-facing documentation: [quickstart](guide/quickstart.md), [configuration](guide/configuration.md), and [instruction files](guide/instructions.md).
6-
7-
## Internal
8-
9-
Research findings, architecture notes, and project status.
10-
11-
| Document | Description |
12-
| -------------------------------------------------------------- | ---------------------------------------------------------------------- |
13-
| [roadmap.md](roadmap.md) | Project status: working features, current focus, planned phases |
14-
| [research/anthropic-api.md](research/anthropic-api.md) | Anthropic API auth: OAuth flow, required headers, system prompt prefix |
15-
| [research/extended-thinking.md](research/extended-thinking.md) | Extended thinking: content block types, signatures, round-tripping |
16-
| [research/system-prompt.md](research/system-prompt.md) | System prompt architecture: section assembly, CLAUDE.md, caching |
5+
| Directory / File | Description |
6+
| -------------------------- | ------------------------------------------------------ |
7+
| [`guide/`](guide/) | User-facing documentation: quickstart, config, howtos |
8+
| [`research/`](research/) | Architecture research and API reference notes |
9+
| [`roadmap.md`](roadmap.md) | Project status: working features, current focus, plans |

docs/research/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Research Notes
2+
3+
Architecture research and API reference notes for oxide-code development.
4+
5+
| Document | Description |
6+
| ----------------------------------------- | ---------------------------------------------------------------------- |
7+
| [Anthropic API](anthropic-api.md) | Anthropic API auth: OAuth flow, required headers, system prompt prefix |
8+
| [Extended Thinking](extended-thinking.md) | Extended thinking: content block types, signatures, round-tripping |
9+
| [System Prompt](system-prompt.md) | System prompt architecture: section assembly, CLAUDE.md, caching |

0 commit comments

Comments
 (0)