Documentation map

Start with the architecture overview for cross-component relationships, or the component references below. The monorepo guide owns the activation map, CI, deploy and release model.

Where documentation belongs

  • plugins/<p>/docs/user/ holds published end-user help. Follow the canonical writing rules: plain language, user goals, no implementation details.
  • plugins/<p>/docs/ outside user/ holds developer reference that stays in the repository: contracts, hooks, integrations and operational notes. Keep domain-specific knowledge with its owning plugin.
  • themes/extrachill/docs/ holds theme developer reference.
  • Each component’s docs/CHANGELOG.md is release-owned, configured by its Homeboy changelog_target. Leave changelogs and version strings to the release process.
  • Root docs/ holds cross-component architecture and site-level infrastructure documentation, including nginx and Cloudflare configuration.

Do not move developer docs between components just to make the layout uniform. When adding a component docs directory, add it to the index below. Check coverage with node tools/check-docs-index.mjs (also run by the Site infrastructure CI job).

How help reaches docs.extrachill.com

The platform map defines each published platform’s source plugin, docs_subpath, parent slug, audience and optional Docs Agent configuration. Every platform publishes from its plugin’s docs/user/, including Connect Your AI (plugins/extrachill-docs/docs/user/). Studio help is configured as private. A docs directory alone does not opt a component into publishing.

The manually dispatched Docs Agent workflow uses that map to propose changes under the configured component’s docs/user/ path, following the writing rules and voice checks. Only entries with runner configuration participate; this workflow writes help, not developer reference.

After reviewed changes merge, the normal component deploy ships the Markdown files. On the docs site, extrachill-docs/publish-plugin-docs reads the installed mapped files (direct *.md children of docs_subpath, not recursively), then calls extrachill-docs/upsert-doc-page to create or update pages. The hourly scheduled check fingerprints installed content and publishes changed sources; it does not fetch from GitHub. Publishing is additive: missing source files are reported as orphans, not automatically deleted. Keep filenames stable to update existing pages in place. Developer references, changelogs and root architecture docs are not published by this pipeline.

Component index

Links use an existing docs index or overview where available; otherwise they open the docs directory listing. Some components currently contain only a release changelog; their README is the developer entry point until reference docs are added.

Plugins

Component documentationPurpose
extrachill-ai-adventureAI adventure experience on the main site; currently changelog only.
extrachill-analyticsNetwork analytics, experiments, privacy and measurement contracts.
extrachill-apiCentral extrachill/v1 REST route and API infrastructure reference.
extrachill-artist-platformArtist profiles, rosters, artist access and link-page integrations.
extrachill-blogEditorial site behavior, homepage and artist dispatch rollout.
extrachill-bookingBooking component on the events site; currently changelog only.
extrachill-cacheNetwork caching infrastructure; currently changelog only.
extrachill-cliUnified wp extrachill command surface; currently changelog only.
extrachill-communityCommunity forums, profiles, social features and user help.
extrachill-contactMain-site contact functionality; currently changelog only.
extrachill-content-blocksShared content blocks and photo-contest operations.
extrachill-docsDocumentation hub and publishing component; currently changelog only here, with publishing sources linked above.
extrachill-eventsCalendar, event submissions, venues, booking and settlement contracts.
extrachill-link-pagesLink-page functionality and verification notes.
extrachill-mcpAuthenticated MCP access to platform abilities; currently changelog only.
extrachill-networkNetwork configuration, site identity, cross-site routing and service assertions.
extrachill-news-wireNews wire ingestion and source provenance.
extrachill-newsletterNewsletter API and integrations.
extrachill-searchCross-site search; currently changelog only.
extrachill-seoNetwork SEO functionality; currently changelog only.
extrachill-shopShop and ecommerce integration.
extrachill-studioInternal editorial workspace and private user help.
extrachill-usersShared identity, authentication, profiles, onboarding and notifications.

Theme

Component documentationPurpose
extrachillShared theme routing, hooks, assets, design system and plugin integration contracts.