registrystack / registrystack/registry-stack

docs hygiene: personal archive remote in repo-docs.yaml, pre-existing markdownlint and vale findings

Open
#895 1 comment 0 reactions 0 assignees View on GitHub
area:docs criticality:p3 documentation needs-jeremi-decision
Dominant language
Rust
Stars
2
Forks
0
Avg merge
2h 57m
Merged PRs (30d)
128

Description

## Context

Found during the review of PR #851 in docs content and lint that the PR did not touch.

## Gaps

- `docs/site/src/data/repo-docs.yaml` points the manifest `archive_remote` at a personal repository (`github.com/jeremi/registry-manifest`) rather than an organization one.
- Pre-existing markdownlint findings: `crates/registry-mint/README.md` MD040 at two fences, `products/evidence/OPERATOR-CONTRACT.md` MD040 and MD022.
- Pre-existing vale findings: a repetition false positive in `products/evidence/CONFIG.md` and a "just" suggestion in the Evidence tutorial page.

## Acceptance

- The archive remote names the organization repository or the entry records why a personal one is right.
- markdownlint and vale are clean on the listed files, with vale exceptions recorded in the style config rather than the prose where the finding is false.

Contributor guide

Open the contributing guide

Research direction

Start with docs/site/src/data/repo-docs.yaml and verify the archive_remote entry, then run the repository's markdownlint and vale checks against the listed README, operator contract, configuration, and Evidence tutorial files. Review the style configuration for any false-positive vale exception. Done means the remote is justified or organizational, the listed markdown findings are resolved, and the checks are clean.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, yaml
Domain
documentation, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
67/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.