Skip to content

docs: rewrite README as short entry point with Node 22-26 policy (#966) - #1123

Merged
Nanle-code merged 8 commits into
Nanle-code:masterfrom
Grace-ope:docs/966-consolidate-root-guides-v2
Sep 30, 2026
Merged

Nanle-code merged 8 commits into
Nanle-code:masterfrom
Grace-ope:docs/966-consolidate-root-guides-v2

Conversation

@Grace-ope

Copy link
Copy Markdown
Contributor

Summary

Closes #966.

Supersedes #1076 (conflicts were too complex for the GitHub web editor: root guide delete/modify vs master).

This branch is cut from an updated master and re-applies the docs consolidation cleanly.

Changes

  • Root keeps only standard meta docs (README, CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, LICENSE, CHANGELOG) plus normal project folders
  • Former root Markdown guides live under docs-site/docs
  • README rewritten as a short entry point: what it is, requirements, quick start, feature map, links
  • One Node policy: 22–26 (>=22 <27) with pnpm 9+, aligned with package.json engines
  • Removed stray closes #550 and the old long fee-prediction-only README shape

Out of scope

Test plan

  • Root no longer lists the moved guide files
  • Guides open under docs-site/docs
  • README Node range matches package.json engines
  • CI / docs drift checks pass when workflows are approved

Note for maintainers

Please close #1076 as superseded by this PR if it is still open.

@vercel

vercel Bot commented Sep 29, 2026

Copy link
Copy Markdown

@Grace-ope is attempting to deploy a commit to the nanle-code's projects Team on Vercel.

A member of the Team first needs to authorize it.

@Grace-ope

Copy link
Copy Markdown
Contributor Author

Superseded by #966 — fresh branch from updated master to avoid conflicts that cannot be resolved in the web UI.

@Nanle-code

@Nanle-code
Nanle-code merged commit 8bfc9d7 into Nanle-code:master Sep 30, 2026
9 of 32 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.

[2026 Docs] Consolidate 30 root-level Markdown guides into docs-site and fix README contradictions

2 participants