Skip to content

remove public docs surface#243

Merged
nahiyankhan merged 1 commit into
mainfrom
codex/remove-public-docs
Jul 20, 2026
Merged

remove public docs surface#243
nahiyankhan merged 1 commit into
mainfrom
codex/remove-public-docs

Conversation

@nahiyankhan

Copy link
Copy Markdown
Collaborator

Category: improvement
User Impact: The public site now presents only ghost's thesis instead of implying that the project is ready for documentation-led adoption.
Problem: The docs surface and persistent menu suggested an onboarding and support posture that ghost is not ready to maintain.
Solution: Remove the public docs routes, MDX pipeline, menu, generated CLI reference, and related maintenance checks. Keep the homepage as the sole public surface, redirect old paths home, and direct command questions to CLI help.

Validation:

  • pnpm check: passed
  • pnpm test: 192 passed, 1 skipped
  • pnpm build: passed
  • Browser check: homepage rendered without a menu; /docs redirected to /

Changeset: added a patch changeset for the public README and documentation-link cleanup.

ghost Review:

  • ghost check --base origin/main: not run because the current CLI does not expose a check command.
  • ghost review --base origin/main --include-memory: not run because the current CLI does not support --include-memory; visual output was reviewed directly in-browser.
File changes

.changeset/honest-development-preview.md
Records the public-package documentation cleanup.

README.md, packages/ghost/README.md
Replace documentation links with the project-site framing and direct readers to CLI help for current command behavior.

CLAUDE.md, CONTRIBUTING.md, docs/README.md, docs/purposes.md, apps/docs/README.md
Remove stale docs-generation instructions and describe apps/docs as the public thesis site.

apps/docs/src/App.tsx
Remove docs routes and the persistent dock; redirect all non-home routes to /.

apps/docs/src/app/page.tsx, apps/docs/src/components/docs/hero.tsx, apps/docs/src/components/docs/docs-page-layout.tsx, apps/docs/src/styles/marked-doc.css
Keep the revised homepage, remove its docs CTA and menu dependency, and retain only styles used by the thesis surface.

apps/docs/src/app/docs/**, apps/docs/src/content/**, apps/docs/src/routes/**, apps/docs/src/mdx-components.tsx, docs-only components
Remove the public documentation pages and their rendering/navigation infrastructure.

apps/docs/vite.config.ts, apps/docs/package.json, pnpm-lock.yaml, apps/docs/src/vite-env.d.ts
Remove MDX and documentation-only build dependencies.

package.json, scripts/check-docs-frontmatter.mjs, scripts/dump-cli-help.mjs, scripts/check-terminology.mjs, apps/docs/src/generated/cli-manifest.json
Remove obsolete docs-frontmatter and generated CLI-manifest maintenance paths.

Screenshots/Demos: Homepage rendered locally after removing the menu; no new visual design beyond the existing homepage work.

@nahiyankhan
nahiyankhan marked this pull request as ready for review July 20, 2026 20:30
@nahiyankhan
nahiyankhan merged commit 962094e into main Jul 20, 2026
3 checks passed
@nahiyankhan
nahiyankhan deleted the codex/remove-public-docs branch July 20, 2026 20:30
@github-actions github-actions Bot mentioned this pull request Jul 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant