Repository navigation
feat(specifications): edit entries and propose new ones from the registry pages - #77
Merged
Merged
Conversation
…stry pages Add an in-page editor to the specification registry so contributors can propose changes without editing YAML by hand. - "Suggest a change" now turns a specification page into an editor: an edit button next to every value that comes from the entry's file, each opening a control that fits the field (custom drop-downs for statuses and verdicts, a searchable licence picker with an "Other licence" option and scopes, an organization picker, mode chips, year, count, date and URL inputs with validation). - Values that depend on each other stay consistent while editing: the MDIP status follows the criteria verdicts (same rule as specs-check), a closed or restricted licence sets "Free of cost restrictions", a new adopters count takes today's date and the matching tier, and an inactive lifecycle makes the status inactive. - Changes are reviewed in a dialog and sent as a pre-filled GitHub issue from the new specification-edit.yml form, with a before/after table and the same change as YAML for the file. The draft is kept in localStorage until it is sent, so signing in or creating a GitHub account does not lose it; a sign-up link returns to the pre-filled form. - New /specifications/new/ page: a blank entry opened in the same editor, with the registry id derived from the short name and checked for uniqueness. It sends the complete new file. Linked as "Propose a new specification" on every entry and from the registry page. - History now lists who took part in each change from the GitHub timeline: "Discussed with" (up to three names, then "and N more"), "Approved by", and "Merged by" only when nobody approved. Open suggestions sent from the editor appear under "Proposed changes". - The filter panel on wide screens no longer has its own scrollbar: it scrolls with the page until its last filter is visible and comes back as soon as the page scrolls up. - The editor draws organization monograms only, so it loads nothing from third-party hosts. - Point the local preview config at config/en/properdocs.yml and document the new contribution flow in README.md and data/README.md. The issue form only takes effect once it is on main. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
| @@ -4,13 +4,13 @@ | |||
| { | |||
| "name": "mkdocs-en", | |||
Contributor
There was a problem hiding this comment.
mkdocs -> properdocs?
| @@ -4,13 +4,13 @@ | |||
| { | |||
| "name": "mkdocs-en", | |||
| "runtimeExecutable": "mkdocs", | |||
Contributor
There was a problem hiding this comment.
mkdocs -> properdocs?
| "port": 8000 | ||
| }, | ||
| { | ||
| "name": "mkdocs-en-alt", |
Contributor
There was a problem hiding this comment.
mkdocs -> properdocs?
| }, | ||
| { | ||
| "name": "mkdocs-en-alt", | ||
| "runtimeExecutable": "mkdocs", |
Contributor
There was a problem hiding this comment.
mkdocs -> properdocs?
| @@ -50,6 +52,7 @@ change" on a specification's page opens that file in GitHub's editor. | |||
| | `scripts/spec_api.py` | Builds the `/api/` files: catalogue, full records, export CSV, the OpenAPI description, and its Swagger UI page at `/api/docs/`. | | |||
| | `scripts/check_specs.py` | `make specs-check`: validation, also run on every pull request. | | |||
| | `hooks/specifications.py` | MkDocs hook that renders the pages and publishes the API. | | |||
Contributor
There was a problem hiding this comment.
MKDocs -> ProperDocs?
fredericsimard
requested changes
Nov 18, 2026
fredericsimard
left a comment
Contributor
There was a problem hiding this comment.
Many Mkdocs remain, we switched to ProperDocs and not going back so you can do a search/replace if need be in the future.
Address review feedback on PR #77: the project switched to ProperDocs, so leftover MkDocs mentions are updated. - .claude/launch.json: rename the preview configurations to properdocs-en / properdocs-en-alt and run the properdocs executable. - README, Makefile, hooks/specifications.py, scripts/spec_api.py, overrides/sitemap.xml, .gitignore: say ProperDocs in prose and comments. Left unchanged on purpose: the `mkdocs` Python import and logger name in hooks/specifications.py, PyPI package names in requirements.txt and the Makefile, and the "Material for MkDocs" theme name, since those are real identifiers or third-party product names. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
In-page editor ("Suggest a change")
data/specifications/<id>.md).make specs-check);Sending a suggestion
.github/ISSUE_TEMPLATE/specification-edit.ymlform. The issue holds the table and the same change as YAML for the file.Proposing a new specification
/specifications/new/is a blank entry opened in the same editor.History
Filter panel
Other
.claude/launch.jsonnow points atconfig/en/properdocs.yml.README.mdanddata/README.mddescribe the new contribution flow.Why
Contributors no longer have to edit YAML in GitHub's editor, and the editor only offers valid values. The site still needs no backend: GitHub issues remain the place where changes are reviewed in public.
Notes for reviewers
main. Until then, the "Continue on GitHub" link will not find the template.make specs-checkpasses, the site builds, and the editor, review dialog, saved draft, History and filter panel were tested in the browser (desktop and mobile). No real issue was submitted. Signing up on GitHub and coming back to the form was not tested with a real account.🤖 Generated with Claude Code