Skip to content

docs: rewrite the next documentation from code evidence - #57

Merged
suiramdev merged 2 commits into
devfrom
docs/apply-anti-slop-recommendations
Oct 17, 2026
Merged

suiramdev merged 2 commits into
devfrom
docs/apply-anti-slop-recommendations

Conversation

@suiramdev

Copy link
Copy Markdown
Owner

Summary

This change writes the 22 pages of next again from evidence in the code. Six inventories list each fact with its source file or the command that showed it. Look at docs/audit/docs-plan.md first, then at get-started/install.mdx.

Motivation

  • The old pages had about 20 statements that the code contradicts.
  • Some facts were on two pages, and the two copies did not agree.
  • Some links on next pointed at main, and those files are not on main. The links gave HTTP 404.
  • All pages had the same <title> and no meta description.

Drawbacks

  • The rewrite changes almost all of next, so the diff is large.
  • next links point at dev. The snapshot pins them to the tag at release.
  • Four review rounds ran. Only round 1 used a different model.

Prior art

  • The first pass corrected the old pages. It did not write them again.
  • A generated procedure reference needs .output() and .errors() in packages/api. That is a code change, so it is not in this PR.

Notes

  • Visual change: each docs page now has its own <title> and meta description.
  • Tests: none added. docs:check --strict, the build, types:check and env:check pass.
  • Docs: all 22 next pages. The 0.1 folder did not change.
  • UI text: assistant_model_none_chosen and onboarding_country_description changed in en.json and fr.json.
  • Not tested: the Dokploy and Coolify panels, a real bank, email delivery, external sign-in, passkeys.
  • A maintainer must answer the questions in docs/audit/docs-plan.md.

The second review found 21 problems in the rewritten pages and the
audit files. This commit corrects them.

- Remove the email address change. The code does not configure it.
- Remove the "Reconnect to resume importing" glossary entry. No code
  sets the status that shows it.
- Replace the sign-in rate-limit table with a link to the API page.
- Deploy the Dokploy compose file from `dev`. The snapshot pins the
  branch to `main` in each frozen version.
- Keep each repeated fact on its owner page and link to it.
- Record the four review rounds in docs/audit.
@coderabbitai

coderabbitai Bot commented Oct 17, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 04287f98-626d-456e-b28e-d41a5e200f4d

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@suiramdev
suiramdev merged commit 4cfd402 into dev Oct 17, 2026
3 checks passed
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