#91: documentation updates post November ballot #105
Merged
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.
#91 documentation updates post November ballot.
A summary of changes include:
CONTRIBUTING.md
was updated to fix typos and incorrect references (e.g., referring to Issues within the Discussion header of the document). The example Issue used for Branch and Pull Request naming conventions was previously We have discussions now! #15, which was a Discussion. This was changed to Add examples for Cat-VRS data classes #87 for consistency since it follows the recommended format.CONTRIBUTING.md
also references themain
branch in the Pull Requests section. This was changed to reference theDefault
branch and hyperlinks to the branches page, since this repository currently uses1.x
as theDefault
branch and presumably this name will change with subsequent releases.I also added details to the root
README.md
that:schema/cat-vrs/def
andschema/cat-vrs/json
after regenerating def and json files following schema changes.docs/source/concepts
, if relevant, after contributing to schema and regenerating docs.A (maybe controversial) change that I added was:
Two documentation items that were identified, but can be made into their own Issues are:
docs/source/concepts/
CONTRIBUTING.md
references a style guide whose link is now broken and the file is currently indocs/tobedeleted/
. va-spec still has this file indocs/source
.