Skip to content

docs(landing): add public "How Logion works" page (closes #163)#170

Open
qingguang2025-cmyk wants to merge 1 commit into
nicolasmelo1:mainfrom
qingguang2025-cmyk:docs/landing-how-it-works
Open

docs(landing): add public "How Logion works" page (closes #163)#170
qingguang2025-cmyk wants to merge 1 commit into
nicolasmelo1:mainfrom
qingguang2025-cmyk:docs/landing-how-it-works

Conversation

@qingguang2025-cmyk

Copy link
Copy Markdown

Summary

Closes #163. Adds a public "How Logion works" page so visitors can understand the product without installing the CLI.

This is a documentation-only change to the landing page — no behavior, pricing, or trust claims were altered beyond what the issue requested.

What changed

  • **** (new): explains the marketplace loop, what a course bundle is, what / declarations do, first steps by audience (buyer / creator / contributor / reviewer), install, and an honest trust model.
  • ****: reuses the existing legal-page rendering path for a new route (HTML + ), registers it in , and folds it into so agents get the full explanation in one fetch.
  • ****: content block, top-nav link, breadcrumbs, and an entry.
  • ****: covers the new route (HTML + markdown), sitemap / listing, and folding.

Notes

  • All CLI examples use the real, documented verbs from the existing landing copy (no invented commands).
  • The trust section explicitly states runtime sandbox enforcement is future work and is not claimed as solved, matching the rest of the site.
  • Passes and ; 113 landing tests green.

Verification

Closes nicolasmelo1#163. Adds a visitor-facing documentation page that explains the
product without requiring the CLI, per the bounty request.

- content/how-it-works.md: marketplace loop, course bundles, capability
  declarations, first steps by audience (buyer / creator / contributor /
  reviewer), install, and an honest trust model.
- main.py: reuse the legal-page rendering path for a new /how-it-works
  route (markdown + HTML), register it in PUBLIC_PATHS, and fold it into
  /llms-full.txt so agents get the full explanation in one fetch.
- site.yaml: how_it_works content block, top-nav link, breadcrumbs,
  and an llms.txt entry.
- tests: cover the new route (HTML + markdown), sitemap/llms.txt listing,
  and llms-full folding.

Passes audit_public_safe and check_doc_links; 113 landing tests green.
@nicolasmelo1

Copy link
Copy Markdown
Owner

Review — request changes

Thanks for the focused public-product explanation and for covering HTML, Markdown, sitemap, llms.txt, and llms-full.txt. The runtime-sandbox caveat is also appropriately honest.

High

  1. The Contributor section gives the wrong role and an invalid CLI invocation.
    packages/landing/landing/content/how-it-works.md:82

    It tells a contributor to run logion bounties create, which opens a bounty rather than submitting work to one. The example also uses --reward, but the current CLI requires --description and --reward-cents for bounties create.

    Please either:

    • make this a creator example with a complete valid bounties create command, or
    • make it a contributor example using logion bounties submissions create BOUNTY_ID --title ....
  2. CI is currently failing on four Ruff E501 violations.
    packages/landing/landing/main.py:187,336,563 and packages/landing/tests/test_landing_routes.py:230.

    Please run the repository lint/format checks and wrap these lines.

Medium

  1. Bounty acceptance must remain distinct from publication.
    how-it-works.md:35-36,102

    The text says accepted work “ships as a new reviewed version.” Acceptance creates the contributor payment outcome, but publication review still determines whether the work becomes a new course version. Please state that accepted work remains subject to publication review before it can ship.

  2. Avoid framing capability declarations as a guarantee of negative behavior.
    how-it-works.md:56-61

    “what the bundle will not do” sounds like an enforceable runtime guarantee, while runtime sandbox enforcement is explicitly future work. Please use wording such as “expected tools, permissions, and behavior for inspection and review.”

Low

legal_page / legal.html now render a non-legal product document. Not blocking, but a neutral abstraction would be clearer if this route pattern expands.

Please address the high-severity items and re-request review.

@nicolasmelo1 nicolasmelo1 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a little couple issues

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.

Expand product documentation on the landing site

2 participants