Plan Your Editing Workflow

Compass works best when the editing flow is simple enough for writers and developers to share. ## Decide who edits what Before more people start touching the repo, define a lightweight ownership model: - one person owns theme configuration - one or more people maintain content - reviewers check technical accuracy before publishing ## Common collaboration flow A lightweight workflow is usually enough: 1. Write or update the article in src/content/docs 2. Preview the change locally with npm run dev 3. Run npm run check 4. Open a pull request for review 5. Build before merging with npm run build ## Files your team will touch most often Editors will usually work in: - src/content/docs/... - src/data/docs.ts - site.config.mjs Developers or maintainers may also update: - page layouts - sidebar behavior - code block styling - search UI ## Keep content changes easy to review Try to keep article updates small and focused. For example: - one article improvement per PR - one navigation adjustment per PR - one styling pass per PR That makes it easier for teammates to review content quality and UI changes separately. ## Suggested review checklist - Is the article title clear? - Does the category still make sense? - Are code samples still accurate? - Are links and commands still valid? With that in place, Compass becomes a maintainable docs system instead of just a starter repository.