feat(docs): RoboLedger guides for planning, mapping, schedules and the app - #1430
Conversation
The product lane published markdown only: an image link was left as written and its file never reached the CDN, and every page landed in one flat sidebar list. A page can now show a file from its site's images/ folder, which the build rewrites to the content CDN and ships, failing on one that does not exist. A page's section front matter groups it in the sidebar, which the apps already render.
New pages for planning and forecasting, asking about the books, comparing with public companies, mapping the chart of accounts, schedules, transactions that change in QuickBooks after a sync, and a tour of the app. The existing pages link into them and go deeper on the close, reports and troubleshooting, and the sidebar groups all fifteen into four sections. Screenshots are the demo company, in the dark theme the docs pages use.
|
Change classification: normal — platform or application code changed. A normal change carries a documented automated review on this pull request before merge, in place of a second human approver. The |
|
@claude please review this PR |
|
Claude finished @jfrench9's task in 3m 14s —— View job Review: RoboLedger docs depth
Verdict: looks good, no blocking issues found. This is a well-scoped, carefully-written PR — I did a close read of the publisher diff, the new tests, and all 26 changed files rather than skimming. Publisher (
|
Summary
The RoboLedger product docs covered connecting, the close and reports, and said almost nothing about planning and forecasting, mapping, schedules or the app itself. This adds seven pages, deepens the existing eight, and adds screenshots. Two small publisher changes make that possible: the product lane can now ship images, and the sidebar groups pages by section.
Product docs publish on merge to
main, so merging this puts the pages live onroboledger.ai/docs.Changes
Publisher (
robosystems/scripts/publish_docs.py)images/folder. The build rewritesto the content CDN and adds the file to the output, the same way the wiki lane already does. An image that does not exist, or sits outsideimages/, fails the build. A file no page shows is reported as a warning and not shipped. Dotfiles are skipped.sectionfront matter groups it in the sidebar. Sections appear in the order of their first page. A site that names no sections produces exactly the single untitled list it did before, sodocs/product/robosystems/is unchanged. The apps already render titled sections for the technical docs, so nothing changes there.build_producttakesasset_baseas an optional fourth argument, defaulting to the public CDN, so the existing caller intests/scripts/test_product_docs.pyis untouched.New pages (
docs/product/roboledger/)plan-and-forecast.md: scenarios, the four drivers, numbers set directly on a line, per-line growth, what carries forward, the three-statement calculation and its monthly checks, the Plan page, re-running after a close, and what forecasting does not do.ask-about-your-books.md: what Claude can read, the difference between live, closed-month and report figures, ratios, and how to ask so an answer can be checked.compare-with-public-companies.md: adding the SEC filings graph as a second connection, and making a comparison fair.map-your-chart-of-accounts.md: what the first sync maps, reviewing it, and why mapping comes before the close.schedules.md: what a schedule is, setting one up with Claude or in the app, ending one early, and how schedules carry into forecasts.changes-after-sync.md: transactions edited in QuickBooks after they synced, and the three ways to settle one.the-roboledger-app.md: a tour of the app by sidebar section.Existing pages
month-end-close.md,reports-and-sharing.mdandtroubleshooting.mdgo deeper (the app's side of the close, what happens after it, reading and regenerating a report, seven new troubleshooting entries).index.md,connect-your-books.md,what-claude-can-do.md,what-it-needs.mdandquickbooks-write-back.mdlink into the new pages. Every page gainedsectionand a neworder; no slug changed, so no URL moves.Screenshots (
docs/product/roboledger/images/, 8 PNGs, about 820 KB)docs/product/README.mdrecords the conventions:section, where images go, dark theme, a demo company only, alt text as a sentence, and that the pages render markdown only.Worth a reviewer's eye: each page is a public claim about what the product does today. Pages name no MCP tools, so the pin in
test_product_docs.pystays at zero. Bank feeds and custom taxonomies are left out on purpose.Breaking Changes
None. No API, schema or SDK surface is touched.
Testing
uv run pytest tests/scripts/test_publish_docs.py tests/scripts/test_product_docs.py: 36 passed, including five new tests for images and sections and the existing check that the real product pages build without errors.just docs-build: 54 pages, 63 files, no warnings or errors. Checked the builtindex.jsonsections and the rewritten image URLs.just test-code: ruff, format and basedpyright clean.just test-allunit suite was not run; the change is confined to the publish script, its tests and markdown.Certification
🤖 Generated with Claude Code