Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#91: documentation updates post November ballot #105

Merged
merged 11 commits into from
Feb 11, 2025

Conversation

brendanreardon
Copy link
Collaborator

#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 the main branch in the Pull Requests section. This was changed to reference the Default branch and hyperlinks to the branches page, since this repository currently uses 1.x as the Default branch and presumably this name will change with subsequent releases.
  • Broadened description of Categorical Variant class, from @rhdolin's recommendation.

I also added details to the root README.md that:

  • Encourages contributors to run tests locally before pushing commits after contributing to the schema.
  • Reminds contributors to commit changes to schema/cat-vrs/def and schema/cat-vrs/json after regenerating def and json files following schema changes.
  • Reminds contributors to make and commit changes to docs/source/concepts, if relevant, after contributing to schema and regenerating docs.

A (maybe controversial) change that I added was:

  • Changed the maximum pixels of the cat-vrs cat in the root README.md to be 300 pixels, so that users see that there is additional documentation in the README.

Two documentation items that were identified, but can be made into their own Issues are:

  • Updating descriptions of concepts within docs/source/concepts/
  • CONTRIBUTING.md references a style guide whose link is now broken and the file is currently in docs/tobedeleted/. va-spec still has this file in docs/source.

Copy link
Collaborator

@DanielPuthawala DanielPuthawala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks all good to me! And yea, the Readme is functionally improved with a slightly smaller catstronaut. XD

@larrybabb larrybabb merged commit 9e5ab96 into 1.x Feb 11, 2025
12 of 13 checks passed
@larrybabb larrybabb deleted the 91-documentation-updates-post-ballot branch February 11, 2025 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants