Skip to content

Render authors from YAML front matter - #552

Open
lubianat wants to merge 29 commits into
ome:mainfrom
lubianat:rfc_yaml_header
Open

Render authors from YAML front matter#552
lubianat wants to merge 29 commits into
ome:mainfrom
lubianat:rfc_yaml_header

Conversation

@lubianat

@lubianat lubianat commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

First step towards a system with more automation/standardization for rfc status management.

German-BioImaging/ome-zarr-ideas#54

  • feat: build authors from yaml header
  • test setup for rfc 9 comment 5
grafik

Next steps:

  • Change the metadata for other reviews / comments
  • Build the summary on the RFC main page from the index
  • Build the overall index from the metadata on each page using a decision tree (has comment -> y, etc etc)
  • Validate the front matter in target documents with a LinkML schema

EDIT: Ready to review!

To review:

  • Compare the generated RFC pages with the older one.

  • Provide feedback on the new look and feel and if changes are needed

  • Compare the page listing the different RFCs with the older one

  • If checking all 57 documents is too much, pick a sample and see if it is okay

  • If you are a schema person, look at rfc/schema/front_matter.yaml for the LinkML schema

  • If you are a sphinx person, look at _ext and document_authors.py and rfc_status.py and see if the directives make sense

Note that a lot of the code and changes have been aided by a Claude Opus 5 agent, though I tried to steer for minimal changes and maximize readability.

@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Automated Review URLs

@jo-mueller

jo-mueller commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Might benefit from a template, i.e. for RFCs and comments?

@jo-mueller

Copy link
Copy Markdown
Contributor

Also; it may be worth to drop the affiliations from the rendered text, similar to how it's done at ngff-spec. The reasoning there was, that a person's orcid is likely informative enough about past and present affiliations.

Comment thread rfc/9/comments/5/index.md
Comment thread rfc/9/comments/5/index.md Outdated
@lubianat

lubianat commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

a person's orcid is likely informative enough about past and present affiliations.

in theory, yes, it should. in practice, I need to keep the information provided by the authors on under which affiliation that comment was made.

an example is the rfc 9 / comment 5

Anna Kreshuk - ilastik was the intended affiliation, though that is a project and not an employee, and not listed on https://orcid.org/0000-0003-1334-6388

@lubianat lubianat added documentation Improvements or additions to documentation infra Concern: basic infrastructure labels Aug 21, 2026
@lubianat lubianat mentioned this pull request Sep 7, 2026
@lubianat
lubianat marked this pull request as ready for review September 9, 2026 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation infra Concern: basic infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants