Skip to content

docs: improve README for developer onboarding#4

Open
dhh1128 wants to merge 2 commits intomainfrom
readme-update
Open

docs: improve README for developer onboarding#4
dhh1128 wants to merge 2 commits intomainfrom
readme-update

Conversation

@dhh1128
Copy link
Copy Markdown
Member

@dhh1128 dhh1128 commented May 8, 2026

Summary

  • Rewrites/improves README.md to follow the Origin platform developer-onboarding template
  • Adds prerequisites, step-by-step clone-to-tests instructions, repo structure, Going Deeper table, and Hard Rules section
  • No source code changes

Test plan

  • README renders correctly on GitHub
  • All links in the Going Deeper table resolve
  • Prerequisites and commands are accurate for this repo

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings May 8, 2026 01:52
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the repository’s README.md to better support developer/contributor onboarding for the origin-docs GitBook-backed documentation site.

Changes:

  • Rewrites the intro to clarify platform context and provide perspective-based navigation links.
  • Adds contributor-focused onboarding: prerequisites, clone steps, manual verification checklist, and repo structure.
  • Adds contributor “key rules” plus a “Going deeper” table of internal/external references.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated

There is no automated test suite. Quality checks are manual:

1. Confirm all internal Markdown links resolve to real files (`grep -r '\]\(\./' .` is a quick scan).
Comment thread README.md Outdated
Comment on lines +91 to +95
│ README.md # vLEI overview and index
│ why.md # Problems solved by vLEIs
│ types.md # LE, OOR, ECR, and QVI vLEI types
│ journey.md # Step-by-step path to vLEI issuance
│ uses.md # Ways to use vLEIs
Comment thread README.md Outdated

Origin is operated commercially by [Provenant](https://provenant.net)™ and its partners. However, it is built atop [open source technologies](https://github.com/WebOfTrust), can be extended via that open source, and supports low-friction interactions with participants in the ecosystem who don't use Origin. 
- If you belong to an org that needs to consume Origin features, see [Clients](perspectives/clients.md).
- If you belong to an org that uses Origin to deliver value-added identity features to others, see [Service Providers](perspectives/sps/).
- Fix `perspectives/sps/` link to point to `perspectives/sps/README.md`
  for consistency with the Going deeper table and to avoid GitHub
  rendering a raw directory listing instead of the page content.
- Broaden the link-verification grep from `\]\(\./'` (only catches
  `./`-prefixed links) to `grep -rP '\]\((?!https?://)'` so it catches
  all non-HTTP internal Markdown links, including `perspectives/...`
  and `concepts/...` style paths used throughout this repo.
- Add missing `├──`/`└──` tree connectors to the `vleis/` subtree in
  the repo structure diagram, making it consistent with all other
  directory entries in the same block.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@dhh1128
Copy link
Copy Markdown
Member Author

dhh1128 commented May 8, 2026

Copilot review fixes applied

Three issues flagged by Copilot have been addressed in commit 429b9d2:

  1. perspectives/sps/ link updated to perspectives/sps/README.md — the directory link rendered as a GitHub directory listing rather than the page content, and was inconsistent with the same link in the "Going deeper" table.

  2. Link-verification grep broadened — the original grep -r '\]\(\./' . only matched links prefixed with ./, missing the majority of this repo's internal links (e.g. perspectives/..., concepts/...). Replaced with grep -rP '\]\((?!https?://)' . which catches all non-HTTP Markdown links.

  3. vleis/ subtree tree-diagram connectors fixed — the five files under vleis/ were missing ├──/└── markers, making them inconsistently formatted compared to every other entry in the repo structure block. Connectors added.

No escalations — all three items were clear, objective fixes.

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.

2 participants