Skip to content

Commit e04985d

Browse files
domenkozarclaude
andcommitted
docs: add documentation site structure to CLAUDE.md
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent de55b8a commit e04985d

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CLAUDE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,29 @@ The integration tests cover:
159159

160160
Note: Some providers (like `env`) are read-only and will skip write tests.
161161

162+
## Documentation Site (`docs/`)
163+
164+
The docs site is an Astro Starlight site deployed to https://secretspec.dev/.
165+
166+
### Structure
167+
168+
- `docs/astro.config.mjs` - Sidebar navigation and site config
169+
- `docs/src/content/docs/` - All content pages (markdown/mdx)
170+
- `index.mdx` - Home page
171+
- `quick-start.mdx` - Getting started guide
172+
- `concepts/` - Declarative config, profiles, providers overview
173+
- `providers/` - Individual provider docs (keyring, dotenv, env, pass, lastpass, onepassword, gcsm)
174+
- `sdk/` - Rust SDK docs
175+
- `reference/` - Configuration, CLI, providers reference, adding providers guide
176+
177+
### What to update
178+
179+
- **New doc page**: Create the `.md` file and add it to the sidebar in `docs/astro.config.mjs`
180+
- **New CLI command**: Update `docs/src/content/docs/reference/cli.md`
181+
- **New config option**: Update `docs/src/content/docs/reference/configuration.md`
182+
- **New provider**: See [Adding Provider Documentation](#adding-provider-documentation) above
183+
- **New concept**: Create `docs/src/content/docs/concepts/<name>.md` and add to sidebar
184+
162185
## Key Files
163186

164187
- `secretspec.toml`: Project secrets configuration

0 commit comments

Comments
 (0)