From 8076cc5e8c4853ee19a5b2df8a11595789ed1f60 Mon Sep 17 00:00:00 2001 From: Jordan Harrison Date: Sun, 20 Sep 2026 20:13:13 +0100 Subject: [PATCH] docs: rewrite guides and simplify documentation pages --- apps/web/app/docs/[...slug]/page.tsx | 22 +- apps/web/app/docs/layout.tsx | 4 +- apps/web/app/docs/page.tsx | 52 +- apps/web/content/docs.manifest.json | 434 ++++---- apps/web/src/components/docs-nav.tsx | 4 +- apps/web/src/components/table-of-contents.tsx | 2 +- apps/web/src/content/facts.ts | 4 +- apps/web/src/styles/globals.css | 20 +- apps/web/src/styles/marketing.css | 91 +- docs/README.md | 228 ++-- docs/administration/antispam.md | 71 +- docs/administration/appearance.md | 99 +- docs/administration/awards-guide.md | 36 +- docs/administration/calendar.md | 42 +- .../community-communications.md | 148 +-- docs/administration/first-steps.md | 45 +- docs/administration/forums.md | 73 +- docs/administration/groups.md | 50 +- docs/administration/manage-members.md | 192 +--- docs/administration/membership-guide.md | 78 +- docs/administration/moderation-guide.md | 53 +- docs/administration/organiser-guide.md | 53 +- docs/administration/reputation.md | 34 +- docs/administration/search.md | 28 +- docs/contributing/architecture.md | 66 +- docs/contributing/board-workspaces.md | 278 +---- docs/contributing/brand.md | 170 +-- docs/contributing/development.md | 77 +- docs/contributing/documentation.md | 66 +- docs/contributing/forms-and-actions.md | 239 +---- docs/contributing/marketplace-maintenance.md | 266 +---- docs/contributing/nextjs-conventions.md | 33 +- docs/contributing/release-infrastructure.md | 559 ++-------- docs/contributing/release.md | 32 +- docs/contributing/rendering-and-data.md | 298 +----- docs/contributing/repository-checks.md | 223 +--- docs/contributing/testing.md | 226 +--- docs/contributing/ui-conventions.md | 73 +- docs/extensions/extensions.md | 36 +- docs/extensions/first-plugin.md | 44 +- docs/extensions/first-theme.md | 28 +- docs/extensions/internationalisation.md | 56 +- docs/extensions/marketplace.md | 46 +- docs/extensions/plugin-hooks-guide.md | 255 +---- docs/extensions/plugin-pages.md | 182 +--- docs/extensions/plugin-presentation.md | 310 +----- docs/extensions/plugin-services.md | 173 +-- docs/extensions/plugin-storage.md | 263 +---- docs/extensions/plugins.md | 38 +- docs/extensions/theme-contract.md | 434 +------- docs/extensions/theme-design.md | 351 +------ docs/extensions/theme-testing.md | 66 +- docs/extensions/themes.md | 34 +- docs/integrations/api-quickstart.md | 44 +- docs/integrations/webhooks.md | 56 +- docs/members/account-security.md | 32 +- docs/members/formatting.md | 70 +- docs/members/member-guide.md | 61 +- docs/members/messages.md | 32 +- docs/members/notifications.md | 38 +- docs/operations/authentication-reference.md | 539 ++-------- docs/operations/backups.md | 73 +- docs/operations/configuration.md | 38 +- docs/operations/coolify.md | 159 ++- docs/operations/custom-board.md | 116 +- docs/operations/database-operations.md | 46 +- docs/operations/deployment.md | 30 +- docs/operations/disaster-recovery.md | 54 +- docs/operations/docker-compose.md | 52 +- docs/operations/environment.md | 52 +- docs/operations/installing.md | 34 +- docs/operations/leaving-vercel.md | 171 +-- docs/operations/local-board.md | 37 +- docs/operations/mail.md | 63 +- docs/operations/migrating.md | 93 +- docs/operations/monitoring.md | 57 +- docs/operations/mybb-content.md | 495 +-------- docs/operations/mybb-discovery.md | 467 +------- docs/operations/mybb-members.md | 670 +----------- docs/operations/mybb-parity.md | 30 +- docs/operations/mybb-permissions.md | 524 +-------- docs/operations/operating.md | 52 +- docs/operations/operator-cli.md | 97 +- docs/operations/phpbb-parity.md | 60 +- docs/operations/scaling.md | 47 +- docs/operations/scheduled-tasks.md | 56 +- docs/operations/single-sign-on.md | 32 +- docs/operations/stripe-setup.md | 192 +--- docs/operations/troubleshooting.md | 41 +- docs/operations/upgrade-notes.md | 503 +-------- docs/operations/upgrading.md | 49 +- docs/operations/vercel-configuration.md | 54 +- docs/operations/vercel.md | 47 +- docs/operations/web-push.md | 219 +--- docs/operations/web-security.md | 106 +- docs/reference/api.md | 161 +-- docs/reference/performance.md | 84 +- docs/reference/plugin-hooks.md | 112 +- docs/reference/theme-slots.md | 190 ++-- docs/start/introduction.md | 44 +- docs/start/quickstart.md | 27 +- packages/api/src/reference.ts | 162 +-- packages/plugin-kit/src/hooks.test.ts | 2 +- packages/plugin-kit/src/hooks.ts | 106 +- packages/plugin-kit/src/payloads.ts | 2 +- packages/plugin-kit/src/regions.ts | 14 +- packages/testkit/src/load/budgets.ts | 37 +- packages/testkit/src/load/cohorts.test.ts | 8 +- packages/testkit/src/load/cohorts.ts | 36 +- packages/theme-kit/src/api.ts | 7 +- packages/theme-kit/src/slots.ts | 87 +- packages/theme-kit/src/view-models.ts | 994 ++---------------- scripts/i18n-baseline.json | 10 +- scripts/perf-docs.mjs | 86 +- scripts/plugin-hook-docs.mjs | 31 +- scripts/site-docs.mjs | 6 +- scripts/theme-api-docs.mjs | 20 +- 117 files changed, 2877 insertions(+), 11822 deletions(-) diff --git a/apps/web/app/docs/[...slug]/page.tsx b/apps/web/app/docs/[...slug]/page.tsx index 019aa9a76..4412d1516 100644 --- a/apps/web/app/docs/[...slug]/page.tsx +++ b/apps/web/app/docs/[...slug]/page.tsx @@ -52,23 +52,13 @@ export default async function DocumentPage({ params }: PageProps) { return (
-
+
{section ? ( {section.title} ) : null} -

{rendered.title ?? entry.title}

-

- {entry.blurb} -

- -
- - {entry.generated ? 'How to update this reference' : 'Edit this page'} - - {entry.generated ? generated from the code : null} -
+

{rendered.title ?? entry.title}

{rendered.headings.length > 0 ? ( @@ -88,10 +78,16 @@ export default async function DocumentPage({ params }: PageProps) { ) : null} -
+
+

+ + {entry.generated ? 'Update this reference' : 'Edit this page'} + +

+