Repository navigation
docs: polish the docs site and hide pricing and managed hosting - #149
Conversation
- Hide the Pricing and Managed Hosting pages (renamed with a _ prefix so Docusaurus skips them) and their navbar and footer links - Contact page: drop the topic picker and Cloud/pricing wording, and use chamals004@gmail.com as the contact email - Match the dark mode background to the navbar and marketing pages - Syntax highlighting for bash, ini, http, sql and nginx code blocks, a neutral dark code background, and calmer light mode code colours - Tech stack: replace Nodemailer with TanStack Query and reword the Next.js and Docker entries
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
chamals3n4
added
Type/Improvement
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Configuration example highlighting docs/docs/administration/authentication.md, docs/docs/getting-started/quick-start.md, docs/docs/operations/upgrading-to-built-in-auth.md |
Environment-variable examples use ini code fences instead of dotenv; their displayed values remain unchanged. |
Site navigation and theme docs/docusaurus.config.ts, docs/theme/Footer/index.tsx, docs/src/css/custom.css, docs/src/components/GithubStar/styles.module.css |
Managed Hosting and Pricing links are hidden. Prism language and color settings, navbar typography, dark-theme colors, and GitHub star icon styling changed. |
Marketing contact content and form docs/src/components/Marketing/ContactForm.tsx, docs/src/components/Marketing/marketing.module.css, docs/src/components/Marketing/offer.ts, docs/src/pages/contact.tsx, docs/src/theme/Footer/index.tsx |
Topic selection was removed from the contact form, which now uses a fixed subject prefix. Contact and footer copy changed, and the contact email address was updated. |
Homepage and sign-in text docs/src/pages/index.tsx, frontend/app/(auth)/login/page.tsx |
The homepage stack descriptions changed. The login button’s submitting label changed from “Signing in…” to “Signing in”. |
Priority:
Estimated code review effort: 2 (Simple) | ~12 minutes
Change: Other
Possibly related PRs
- chamals3n4/OpenATS#139: Updates SMTP setup guidance in the same documentation pages.
- chamals3n4/OpenATS#140: Introduces the marketing pages and components changed in this PR.
Merge Risk: 
37fdb
-
No merge-blocking risk was identified in the documentation and site updates.
Pre-merge checks: 
-
Check name Status Explanation Resolution Docstring Coverage Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surv… Write docstrings for the functions missing them to satisfy the coverage threshold. -
Check name Status Explanation Title check The title clearly summarizes the primary changes: documentation polish and hiding Pricing and Managed Hosting. Description check The description covers the purpose, implementation approach, affected pages, related issues, and checklist. It also reports the docs build result and identifies that pnpm testhas not been confirmed…Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Description check
-
Explanation
The description covers the purpose, implementation approach, affected pages, related issues, and checklist. It also reports the docs build result and identifies that
pnpm testhas not been confirmed. The breaking impact is described under Approach, although a separate Breaking changes heading is absent.
-
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 4 functions across 7 files. (5 skipped: 5 unsupported.)
Resolution
Write docstrings for the functions missing them to satisfy the coverage threshold.
-
Finishing Touches: 💡 1
-
📝 Generate docstrings: 💡
-
- Commit to this branch
- Create a new PR
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
Purpose
UI fixes for the docs site, and hiding the Pricing and Managed Hosting pages until the hosted service is ready.
Approach
pricing.tsxandmanaged-hosting.tsxare renamed to_pricing.tsxand_managed-hosting.tsx, which Docusaurus does not build, so/pricingand/managed-hostingare 404s and left out of the sitemap. Their navbar and footer links are commented out. To bring them back, remove the underscore and uncomment the links.chamals004@gmail.com(CONTACT_EMAILinoffer.ts, also shown in the footer). The footer blurb no longer mentions OpenATS Cloud.#0a0a0abackground and#1f1f1fborders as the navbar and marketing pages.bash/sh,ini,http,sqlandnginx(most code blocks had no highlighting), and changed thedotenvblocks toini(Prism has no dotenv grammar). Dark mode keeps Dracula's token colours on a neutral#171717background. Light mode keeps GitHub's theme with its cyan and pink replaced by the site's teal and a muted amber.remove sign in three dot,frontend/app/(auth)/login/page.tsx).Related issues
Checklist
pnpm testpasses locally.pnpm buildindocs/passes with no broken links.Summary by CodeRabbit