| Field | Value |
|---|---|
| Project team | project-web |
| Repository role | Spectre documentation site |
| Package/artifact | docs-phcdevworks-com |
| Current version/status | 0.0.1 |
- Read AGENTS.md, then the agent-specific guide for the task.
- Check TODO.md and ROADMAP.md for current scope.
- Make the smallest repo-local change that satisfies the task.
- Run
npm run checkwhen validation is required or practical. - Update docs and CHANGELOG.md only when behavior, public contracts, or release-relevant metadata changed.
| Guide | Path |
|---|---|
| Agent rules | AGENTS.md |
| Claude Code | CLAUDE.md |
| Codex | CODEX.md |
| Copilot | COPILOT.md |
| Jules | JULES.md |
| Roadmap | ROADMAP.md |
| Todo | TODO.md |
| Changelog | CHANGELOG.md |
| Security | SECURITY.md |
docs-phcdevworks-com is the official documentation site for Spectre, run by
PHCDevworks. It centralizes implementation guides, reference material, and
supporting documentation for the Spectre ecosystem.
Repository docs: CONTRIBUTING.md | CHANGELOG.md | ROADMAP.md | SECURITY.md | AGENTS.md | CLAUDE.md | CODEX.md | JULES.md | COPILOT.md | LICENSE
This repository contains the Astro-based documentation experience for Spectre. It is intended to stay clear, accurate, and easy to maintain for both internal contributors and external readers.
This site is the documentation home for Spectre. It depends on
@phcdevworks/spectre-ui-astro for Spectre-aligned presentation, but it does
not define upstream design tokens or UI package internals.
- Maintain the Spectre documentation site.
- Update contributor-facing repository docs.
- Adjust docs-site build, preview, deployment, or workspace configuration.
- Keep automation guidance aligned across Claude Code, Codex, Copilot, and Jules.
- Do not define Spectre token contracts here.
- Do not implement source components for
@phcdevworks/spectre-ui. - Do not change company website positioning owned by
www-phcdevworks-com.
- Astro
- TypeScript
- Cloudflare adapter
@phcdevworks/spectre-ui-astro
- Node.js 22.12 or newer
- npm
npm installnpm run dev| Script | What it does |
|---|---|
npm run dev |
Start the local Astro development server |
npm run build |
Create the production build |
npm run typecheck |
Run the Astro TypeScript checker (astro check) |
npm run check |
Full validation gate — runs npm run build then npm run typecheck |
npm run preview |
Build and start a local Cloudflare Workers preview |
npm run generate-types |
Refresh Wrangler type output |
npm run deploy |
Build and deploy to Cloudflare |
npm run checknpm run check runs the production build then the Astro typecheck. Use it
before any handoff. npm run preview builds and starts a local Cloudflare
Workers preview — use this only when you need to verify Cloudflare runtime
behavior specifically.
Build fails with missing module errors — run npm install first; dist/
is not committed and must be rebuilt locally.
npm run preview or npm run deploy fails — these require Wrangler
authentication. Run wrangler login and confirm you have Cloudflare access for
this project before using them.
npm run generate-types produces nothing — run npm run build first;
Wrangler type generation requires a compiled output to inspect.
| Path | Responsibility |
|---|---|
src/pages/ |
Route-level pages for the documentation experience |
src/layouts/ |
Page layout components |
public/ |
Static assets served as-is |
- Claude Code leads primary implementation. See CLAUDE.md.
- Codex handles documentation, releases, production stabilization, repo hygiene, and config standardization. See CODEX.md.
- GitHub Copilot provides general development assistance. See COPILOT.md and .github/copilot-instructions.md.
- Google Jules handles small automated maintenance. See JULES.md.
Shared coordination rules live in AGENTS.md.
Track release-relevant documentation, workflow, and configuration changes in CHANGELOG.md.
See CONTRIBUTING.md.
See LICENSE.
Spectre is run by PHCDevworks. This repository should use Spectre naming and PHCDevworks ownership language consistently across docs, settings, and project configuration.