Skip to content

Conversation

@jkachel
Copy link
Contributor

@jkachel jkachel commented Dec 19, 2025

What are the relevant tickets?

n/a

Description (What does it do?)

Fills out the B2B system documentation:

  • Adds more documentation for the management commands
  • Adds a bunch of technical information about how the system is structured and how it operates
  • Adds some detail for the user-facing interfaces and some run-downs of common scenarios

This also makes some minor changes to the Sphinx configuration to get MyST parser set up. This allows us to write docs in something mostly resembling Markdown along with reStructuredText.

How can this be tested?

Run pants docs :: to generate the docs, then read them. They'll be in dist/sphinx/index.html.

The docs should make sense and cover most everything. Some things are not fully documented on purpose - the management commands, for one; they're covered but the detail is left to the help in the command itself.

@github-actions
Copy link

OpenAPI Changes

Show/hide ## Changes for v0.yaml:
## Changes for v0.yaml:


## Changes for v1.yaml:


## Changes for v2.yaml:


Unexpected changes? Ensure your branch is up-to-date with main (consider rebasing).

@jkachel jkachel changed the title Jkachel/more b2b docs Add more B2B documentation Dec 19, 2025
@cp-at-mit cp-at-mit self-assigned this Jan 5, 2026
@pdpinch pdpinch requested review from cachob and pdpinch January 5, 2026 19:21
@jkachel jkachel merged commit 485a286 into main Jan 7, 2026
9 checks passed
@jkachel jkachel deleted the jkachel/more-b2b-docs branch January 7, 2026 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants