# Project AI Pointers (Template)

## @pagesmith/docs

Install: `npm add @pagesmith/docs`

Use the installed package guidance — these files are version-matched to what you have installed:

### Primary references

- `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/setup-docs.md` — bootstrap/retrofit prompt for setting up docs in an existing repo
- `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/docs-guidelines.md` — AI-first docs writing, organization, built-in docs features, and diagram workflow
- `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/markdown-guidelines.md` — supported markdown syntax, code block features, and diagram embedding rules
- `node_modules/@pagesmith/docs/REFERENCE.md` — complete config, CLI, content structure, frontmatter, markdown, layouts, and deployment reference
- `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/usage.md` — agent rules, integration shape, and copy-paste prompts for common workflows
- `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/errors.md` — error catalog with patterns and fixes

### Task-specific files

| Task | Read |
|---|---|
| Initial setup | `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/setup-docs.md`, `node_modules/@pagesmith/docs/REFERENCE.md`, `node_modules/@pagesmith/docs/schemas/*.schema.json` |
| Writing docs pages (frontmatter, code blocks, diagrams) | `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/docs-guidelines.md`, `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/markdown-guidelines.md`, `node_modules/@pagesmith/docs/REFERENCE.md` |
| Adding or updating diagrams | `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/docs-guidelines.md`, `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/markdown-guidelines.md` |
| Adding sections and restructuring | `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/docs-guidelines.md`, `node_modules/@pagesmith/docs/REFERENCE.md`, `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/recipes.md` |
| Organizing nav with meta.json5 | `node_modules/@pagesmith/docs/REFERENCE.md` |
| Layout overrides and theming | `node_modules/@pagesmith/docs/REFERENCE.md`, `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/recipes.md` |
| Troubleshooting build errors | `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/errors.md` |
| Migration and upgrades | `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/migration.md`, `node_modules/@pagesmith/docs/skills/pagesmith-docs-setup/references/changelog-notes.md` |

### Quick reference

- CLI commands: `pagesmith-docs init`, `pagesmith-docs dev`, `pagesmith-docs build`, `pagesmith-docs preview`, `pagesmith-docs mcp`
- Default ports: dev `3000`, preview `4000`
- Content directory: `docs/` if it exists, otherwise `content/`
- Config `$schema`: `./node_modules/@pagesmith/docs/schemas/pagesmith-config.schema.json` when `pagesmith.config.json5` is at the repo root
- Schema files: `node_modules/@pagesmith/docs/schemas/*.schema.json`
- Config fields: `name`, `title`, `description`, `basePath`, `contentDir`, `origin`, `home`, `server`, `icon`, `favicon`, `maintainer`, `footerLinks`, `footerText`, `copyright`, `search`, `sidebar`, `theme`, `editLink`, `lastUpdated`, `assets`, `analytics`, `packages`

### Core content layer (if also using @pagesmith/core directly)

- `node_modules/@pagesmith/core/REFERENCE.md`
- `node_modules/@pagesmith/core/skills/pagesmith-core-setup/references/usage.md`