Open
Conversation
lubianat
reviewed
Feb 16, 2026
|
|
||
| In the future we will flesh out this page with a guide to RFCs, but in the | ||
| meantime the RFC process is outlined in the | ||
| [Implementation section of RFC 1](../rfc/1/index.md#implementation). |
| please do so via a pull request (PR) against the `main` branch of the [ome/ngff-spec](https://github.com/ome/ngff-spec) repository. | ||
| Such a PR can contain a change of any of the following components of the ngff-spec repo: | ||
|
|
||
| - The spec text itself (`ngff-spec/inex.md`) |
| You can then cite it in the text using the following syntax: | ||
|
|
||
| ```markdown | ||
| This is a citation {cite:t}`citation_key`. |
Contributor
There was a problem hiding this comment.
Maybe use a real example from references.bib? Could make sense to see it rendered.
Also, are there is a https://github.com/ome/ngff-spec/blob/main/references.bib and a https://github.com/ome/ngff/blob/more-contribution-help/references.bib. As the docs live in ngff, the "this repository" may sound ambiguous.
| The spec document under the [ngff-spec](github.com/ome/ngff-spec) repository can be built as a standalone document to make writing and rendering a smoother experience. | ||
| To build the spec document, you first need to install the necessary dependencies: | ||
|
|
||
| After cloning the ngff-spec repo, navigate into the repository on your machine and install the dependencies using pip: |
Contributor
There was a problem hiding this comment.
maybe clarify that one needs to install deps + the repo as an editable package?
(at least that is pip install -e . behaviour)
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
2 participants
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.
Fixes #323
Fixes #276
Re #184
This PR unravels the contribution section in separate subpages for contributing to the website and contributing to the spec. There are now:
cc @erickmartins @govekk @SeanDuHare because we talked about this recently :)