Repository navigation
docs: fewer, shorter pages in one path for new users - #200
Merged
Merged
Conversation
46 pages per language become 25. Duplicates are merged (three quick starts, persistence/versioning/audit, deployment pages, platform pages), contributor pages and the stale roadmap are removed, and the benchmark and metrics pages are cut to what a user needs. The sidebar follows one path: what Ordo is, quick start, writing rules, testing and impact, decision models, running it, Studio and platform, coding agents, reference. Facts checked against the code and fixed: step name is required, contains() is contains_str, min/max take separate arguments, operator precedence, WASM function names, version files are name.vN.json, sub-rule depth limit is 8, release policy fields, default tenants dir, and others. Pages for call_rule_set and $data, which do not work on the server, are left out. ROADMAP.md now points to the website roadmap.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before: 46 docs pages per language. Three different quick starts, overlapping platform pages, contributor-only pages (editor store, benchmark chart internals), a roadmap stuck at v0.5–0.8, 700–850 line benchmark and metrics pages, and several facts that no longer match the code.
After: 25 pages per language in one path: what Ordo is, quick start, writing rules, testing and impact, using a decision model, running it (server, deployment, embedding), Studio and platform, coding agents (Guard, MCP), reference. zh and en have the same pages. Links used by the README (quick-start, platform/cli, decision-gateway, guard, studio) keep their paths.
Facts fixed against the code:
nameis required (rule/step.rs:23)contains()function; it iscontains_str, andcontainsis an operator (parser.rs:137); no[i]indexingmin/maxtake separate arguments (functions.rs:171-201)name.vN.json, not in.versions/(store.rs:28)--signature-allow-unsigned-local falseonly works as an environment variable (config.rs:273-279)--tenants-diris<rules-dir>/tenants/tenants.json(tenant.rs:254)ordo_http_requests_totalis never recorded (metrics.rs:403);network.httpneeds an upper-case methodordo testflagsLeft out on purpose:
call_rule_setand$dataexternal data, which fail on the server today.How: text and sidebar only, plus ROADMAP.md now points to the website roadmap.
npx vitepress buildpasses with no dead links.