Skip to content

refactor: simplify docs into docs/ — remove clients-docs package - #274

Merged
iamnewton merged 2 commits into
mainfrom
refactor/simplify-docs
Aug 14, 2026
Merged

refactor: simplify docs into docs/ — remove clients-docs package#274
iamnewton merged 2 commits into
mainfrom
refactor/simplify-docs

Conversation

@iamnewton

Copy link
Copy Markdown
Contributor

Summary

  • Move all Astro/Starlight content from packages/clients-docs/content/ directly into docs/src/content/docs/ and wire up Starlight's built-in docsLoader()
  • Remove packages/clients-docs and the empty packages/github-client-docs skeleton — both were artifacts of the over-architected federated docs approach
  • Replace docs/astro.config.ts usage of @theholocron/astro-config (which hardcoded the packages/${slug}-docs/content path convention) with vanilla astro/config defineConfig, sidebar inlined
  • Update holocron.config.ts to the simplified { name: "deploy", with: { docs: true } } deploy entry
  • Drop clients-docs from codecov.yml components

Test plan

  • pnpm --filter @theholocron/clients-site build succeeds in docs/
  • Sidebar links resolve correctly (slugs no longer have the clients/ prefix)
  • CI deploy workflow runs against docs/

@iamnewton
iamnewton requested a review from a team as a code owner August 13, 2026 20:44
Move all Astro/Starlight content directly into docs/src/content/docs/
and wire up the standard docsLoader(). Remove the separate
packages/clients-docs workspace package and packages/github-client-docs
skeleton, which were part of the over-architected federated docs approach.

Update docs/astro.config.ts to use vanilla astro/config defineConfig
with the sidebar inlined, dropping the @theholocron/astro-config wrapper
that hardcoded the packages/${slug}-docs/content path convention.

Update holocron.config.ts to the simplified deploy config.
Remove the clients-docs codecov component.

Signed-off-by: Newton <5769156+iamnewton@users.noreply.github.com>
@iamnewton
iamnewton force-pushed the refactor/simplify-docs branch from b8e5b00 to 4bc5806 Compare August 13, 2026 21:18
@codecov

codecov Bot commented Aug 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #274   +/-   ##
=======================================
  Coverage   97.70%   97.70%           
=======================================
  Files          48       48           
  Lines         305      305           
  Branches       53       53           
=======================================
  Hits          298      298           
  Misses          3        3           
  Partials        4        4           
Components Coverage Δ
clerk-client 100.00% <ø> (ø)
confluence-client 100.00% <ø> (ø)
doppler-client ∅ <ø> (∅)
github-client 97.50% <ø> (ø)
google-client 98.11% <ø> (ø)
http-client 90.47% <ø> (ø)
infisical-client ∅ <ø> (∅)
jira-client 100.00% <ø> (ø)
neon-client 100.00% <ø> (ø)
postman-client 100.00% <ø> (ø)
vercel-client 100.00% <ø> (ø)
zendesk-client 100.00% <ø> (ø)
🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…pace package

- Move astro.config.ts to repo root; configure srcDir/outDir/publicDir into docs/
- Switch to @theholocron/astro-config defineConfig and createDocsCollections()
- Delete docs/package.json, docs/tsconfig.json; remove docs/ from workspace
- Add @astrojs/starlight, astro, @theholocron/astro-config, @theholocron/docs-theme
  to root devDependencies; add docs:dev/build/preview scripts
- Add root tsconfig.json extending @theholocron/tsconfig/astro
- Update knip.config.ts to cover astro.config.ts and docs/src/**/*.ts
- Update .gitignore to root-level .astro/ dir
- Bump all @theholocron config deps to ^7.19.0 in catalog

Signed-off-by: Newton <5769156+iamnewton@users.noreply.github.com>
@iamnewton
iamnewton merged commit 8af8df5 into main Aug 14, 2026
39 checks passed
@iamnewton
iamnewton deleted the refactor/simplify-docs branch August 14, 2026 19:29
@iamnewton

Copy link
Copy Markdown
Contributor Author

🎉 This PR is included in version 1.6.7 🎉

The release is available on:

Your semantic-release bot 📦🚀

@iamnewton iamnewton added the released Included in a release label Aug 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released Included in a release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant