search

ethereum-oasis-op / baseline-standard

Repository for the Baseline standards team and specification work
Creative Commons Zero v1.0 Universal
18 stars 33 forks source link

make requirements linkable #90

Closed chaals closed 2 years ago

chaals commented 3 years ago

Markdown is not helpful here, but writing them as e.g.

#### [R43]
Make it possible to link to a requirement, instead of having to point people to the document and then ask them to search for the relevant bit by themselves

would enable links like ..spec.html#[r43] to work

Therecanbeonlyone1969 commented 3 years ago

@chaals ... you are more than welcome to do a PR with that change, if you feel strongly about it.

Therecanbeonlyone1969 commented 2 years ago

@GoldenBit0 @mehranshakeri and @Therecanbeonlyone1969 ... will take this on. @chaals, you are strongly encouraged to participate in this effort in this branch

BriannaMRich commented 2 years ago

@chaals looking for confirmation on the request. Are you looking for the requirements section to be linked - so when they are referred to within the specification and/or outside. See below for example. If this is accurate please let us know :)

[R34] The identifiers and identity utilized in a BPI MUST be controlled by its Principal Owner.

@GoldenBit0

chaals commented 2 years ago

@BriannaMRich Exactly!

BriannaMRich commented 2 years ago

@chaals Great!! @GoldenBit0 FYI

Therecanbeonlyone1969 commented 2 years ago

@chaals ... that is an absolute (to line 721) not a relative (R34) reference. We do need relative references, however.

cc @BriannaMRich ... see the above-referenced branch for relative links.

mehranshakeri commented 2 years ago

Is this already done? I see all the links are already fixed. If not, could you please guide me to where still needs review/correction?

Therecanbeonlyone1969 commented 2 years ago

Is this already done? I see all the links are already fixed. If not, could you please guide me to where still needs review/correction?

@mehranshakeri ... yes in the branch pr/101 ... as soon as the API spec .md file has been brought in alignment with the yaml we will do a PR

Therecanbeonlyone1969 commented 2 years ago

done with #114