Skip to content

Commit b714443

Browse files
committed
docs: organize root documentation
1 parent dfd261c commit b714443

10 files changed

Lines changed: 20 additions & 7 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,5 @@ src-tauri/target/
2727

2828
# Local workspace artifacts
2929
.claude/
30+
.codex/
3031
output/

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<a href="https://code.lovstudio.ai/">Website</a> •
2727
<a href="#overview">Overview</a> •
2828
<a href="#features">Features</a> •
29+
<a href="#documentation">Docs</a> •
2930
<a href="#installation">Installation</a> •
3031
<a href="#usage">Usage</a> •
3132
<a href="#development">Development</a> •
@@ -90,6 +91,15 @@ The goal is simple: arrive at the right project, see the full context, and resum
9091
- In-app update checks, release history, auto-update controls, and direct release links.
9192
- Authenticated Lovstudio feedback tickets with tags, ticket IDs, and admin review tooling.
9293

94+
## Documentation
95+
96+
Project documentation that does not need to live in the repository root is kept under `docs/`.
97+
98+
- [Proxy configuration](docs/proxy-configuration.md)
99+
- [Product requirements](docs/prd-parallel-vibe-coding.md)
100+
- [Warm Academic design guide](docs/design-guide.md)
101+
- [OpenCode research index](docs/research/RESEARCH_INDEX.md)
102+
93103
## oh-my-lovcode
94104

95105
Community configuration framework for Lovcode, inspired by oh-my-zsh.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,18 @@ Due to web access limitations, research focused on **deep analysis of Lovcode's
1010

1111
## Document Structure
1212

13-
All research and specifications are organized in the repository root as Markdown files:
13+
All research and specifications are organized in `docs/research/`:
1414

1515
```
1616
lovcode/
17-
├── RESEARCH_INDEX.md ← YOU ARE HERE (navigation guide)
18-
├── OPENCODE_RESEARCH.md ← Deep architecture analysis
19-
├── SKILLS_INSTALLATION_SPEC.md ← Implementation spec for skills fix
20-
├── SESSION_TAGGING_SPEC.md ← Complete tagging feature spec
21-
├── RESEARCH_SUMMARY.md ← Executive summary & timeline
22-
└── QUICK_START_GUIDE.md ← 5-minute quick reference
17+
└── docs/
18+
└── research/
19+
├── RESEARCH_INDEX.md ← YOU ARE HERE (navigation guide)
20+
├── OPENCODE_RESEARCH.md ← Deep architecture analysis
21+
├── SKILLS_INSTALLATION_SPEC.md ← Implementation spec for skills fix
22+
├── SESSION_TAGGING_SPEC.md ← Complete tagging feature spec
23+
├── RESEARCH_SUMMARY.md ← Executive summary & timeline
24+
└── QUICK_START_GUIDE.md ← 5-minute quick reference
2325
```
2426

2527
## Document Guide
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)