docs(spec): Duvet's Specificaiton #63
Conversation
| and MUST identify the specification that contains this section and content. | ||
| The URL MUST contain a URL fragment that uniquely identifies | ||
| the section that contains this content. | ||
| If the URL only contains a URL fragment |
There was a problem hiding this comment.
This is a bit underspecified to me. What is the scope of the fragment? Should it be limited to a single package? A single repo? Dependencies included? Global? I think we also need to define what it means for "Duvet to manage implementation specific requirements"
There was a problem hiding this comment.
When you say "scope" what do you mean?
If you have a specification that defines a requirement for any of these scopes what do you do?
As I understand it the scope is resolved by the scope of files you feed into duvet.
Currently if you annotate 3 specifications
and feed all these source files but only 2 specs into duvet it gets quite upset.
So I see this as a simple short hand to work around building a TOML file.
Co-authored-by: Cameron Bytheway <[email protected]>
fix: incomplete intro sentence fix: section nesting Co-authored-by: seebees <[email protected]>
Issue #, if available: Duvet Needs a Specification
Description of changes:
Adds
specs, a directory holding:A Specification,
describing the purpose and behavior of Duvet,
written as
duvet-specification.md.A
README.md,describing the purpose of the Specification,
the style conventions followed by it,
and how to use the continuous integration (ci) test and
extraction utilities.
A directory
ci,holding bash script to
prettifythe markdown spec.Some config files for
prettifyA directory
util,holding a node and bash scripts to transform the
markdown spec to an RFC text and TOML files that
the current version of Duvet can then work with.
Testing: CI:
Replaces #61
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.