Provide an approval walkthrough for the other BReg starters

Open Beginner friendly
#1,213 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Start with docs/site/src/content/docs/tutorials/review-breg-changes-in-casework.mdx and compare it with the three starter paths under products/breg/starters/. Update the tutorial or add a pointer so approval, rejection, and application are covered for at least one additional starter, or explicitly for all four; verify the result against the existing professional-licences walkthrough.

Written by the indexing model from the issue text.

Description

area:breg documentation

Three of the four BReg starters lost their worked approval example when they moved to the Casework review authority, and only one got a replacement tutorial. As of PR #1189, agricultural-holdings, seed-lots, and public-organizations all set "authority": "casework" in products/breg/starters/<name>/core/registry.yaml and their core/tests/journeys.yaml / security-journeys.yaml shrank substantially (for example agricultural-holdings/core/tests/journeys.yaml went from 1,114 to 434 lines, security-journeys.yaml from 1,218 to 494). Only professional-licences has a paired walkthrough at docs/site/src/content/docs/tutorials/review-breg-changes-in-casework.mdx.

Failure scenario: someone runs bregctl init --template agricultural-holdings (or seed-lots, or public-organizations), expects a working approve/reject/apply journey the way earlier starter versions had, and finds none of the docs site tutorials cover how to wire that starter's change requests to a review authority; they have to reverse-engineer it from the professional-licences tutorial.

Suggested fix:

  • Add a short docs-site walkthrough (or at least a pointer to the professional-licences one) for at least one of the other three starters, or generalize the existing tutorial to say explicitly that its steps apply to all four.

Filed from the review of #1189; not merge-blocking.

Dominant language
Rust
Stars
2
Forks
0
Avg merge
3h 45m
Merged PRs (30d)
134

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from registrystack/registry-stack

All issues in registrystack/registry-stack

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.