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.

Sign up for GitHub

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

Jump to bottom

120 add figures to documentation #121

Merged
merged 24 commits into from
Mar 14, 2025
Merged

120 add figures to documentation #121

merged 24 commits into from
Mar 14, 2025

Conversation

DanielPuthawala
Copy link
Collaborator

Added documentation to the how-cat-vrs-works section, with figures, alt-text, and a brief overview of how it all works.

@DanielPuthawala DanielPuthawala self-assigned this Mar 12, 2025
@DanielPuthawala DanielPuthawala linked an issue Mar 12, 2025 that may be closed by this pull request
Add figures on what Cat-VRS can do to documentation #120
Closed
@DanielPuthawala
Copy link
Collaborator Author

Oh crud, that trailing whitespace test failed. How do we fix that again?

@jsstevenson
Copy link
Contributor

jsstevenson commented Mar 12, 2025 •
edited
Loading

@DanielPuthawala pre-commit run --all-files trailing-whitespace

but also the latest metaschema processor release shouldn't be doing this anymore -- let me know what version you have locally (edit the release apparently didn't work? will look into this)

I would also recommend making sure you have precommit hooks installed in your local env so you encounter this before pushing to origin

korikuzma
korikuzma requested changes Mar 12, 2025
View reviewed changes
Copy link
Contributor

@korikuzma korikuzma left a comment

Choose a reason for hiding this comment

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

I'd recommend https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker

@brendanreardon brendanreardon force-pushed the 120-add-figures-to-documentation branch from 169f18f to 229c31b Compare March 13, 2025 03:07
DanielPuthawala and others added 10 commits March 13, 2025 10:41
@DanielPuthawala @korikuzma
Update docs/source/how_cat-vrs-works.rst
a042af8 
Kori fixed typo

Co-authored-by: Kori Kuzma <[email protected]>
@DanielPuthawala @korikuzma
Update docs/source/how_cat-vrs-works.rst
035801a 
kori fixes spelling again

Co-authored-by: Kori Kuzma <[email protected]>
@DanielPuthawala @korikuzma
Update docs/source/how_cat-vrs-works.rst
4ccde92 
I suck at spelling

Co-authored-by: Kori Kuzma <[email protected]>
@DanielPuthawala @korikuzma
Update docs/source/how_cat-vrs-works.rst
6636a90 
Thank you for catching these.

Co-authored-by: Kori Kuzma <[email protected]>
@DanielPuthawala @korikuzma
Update docs/source/how_cat-vrs-works.rst
55253b5 
Kori saves the day again

Co-authored-by: Kori Kuzma <[email protected]>
@DanielPuthawala @korikuzma
Update docs/source/how_cat-vrs-works.rst
cf9e9c4 
Kori MVP

Co-authored-by: Kori Kuzma <[email protected]>
@DanielPuthawala @korikuzma
Update docs/source/how_cat-vrs-works.rst
4dab991 
edited prose

Co-authored-by: Kori Kuzma <[email protected]>
@DanielPuthawala @korikuzma
Update docs/source/how_cat-vrs-works.rst
ce0e9dc 
edited prose

Co-authored-by: Kori Kuzma <[email protected]>
@DanielPuthawala @korikuzma
Update docs/source/how_cat-vrs-works.rst
4004f09 
Capitalized Python

Co-authored-by: Kori Kuzma <[email protected]>
@DanielPuthawala @brendanreardon
Update docs/source/index.rst
8dfa41b 
- to _

Co-authored-by: Brendan Reardon <[email protected]>
@larrybabb
Copy link
Contributor

@korikuzma @brendanreardon @DanielPuthawala if the changes are made per Kori's request, can we get a re-approval so this can be merged? I would LOVE to get this in for the Ballot branch first thing tomorrow morning (tick tock)

larrybabb
larrybabb approved these changes Mar 13, 2025
View reviewed changes
Copy link
Contributor

@larrybabb larrybabb left a comment

Choose a reason for hiding this comment

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

i'm good if you guys are. I'm running out of time and I'm confident if there are any minor things we can get these in after we mint a new ballot branch.

brendanreardon and others added 2 commits March 13, 2025 18:53
@brendanreardon @korikuzma
Apply suggestions from code review
f811816 
Co-authored-by: Kori Kuzma <[email protected]>
@brendanreardon
Renamed figures and how_cat_vrs_works.rst. Images showing on readthed…
60342e0 
…ocs and how cat-vrs works moved to after introduction.
brendanreardon
brendanreardon approved these changes Mar 13, 2025
View reviewed changes
Copy link
Collaborator

@brendanreardon brendanreardon left a comment

Choose a reason for hiding this comment

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

I made a commit that:

  • Renamed the figure files to not have spaces
  • Renamed how_cat-vrs_works.rst to how_cat_vrs_works.rst
  • Moved the how catvrs works page to immediately after Introduction in the index.

Approved, well done Daniel!!

@brendanreardon
Copy link
Collaborator

Hmm.. it says that there is still a change requested by Kori but I can't seem to find it...

korikuzma
korikuzma reviewed Mar 14, 2025
View reviewed changes
@brendanreardon brendanreardon merged commit 53f2a46 into 1.x Mar 14, 2025
13 checks passed
@brendanreardon brendanreardon deleted the 120-add-figures-to-documentation branch March 14, 2025 02:26
@brendanreardon
Copy link
Collaborator

Resolved Kori's requests in 4a44ac0 and 913d3d3 and then merged the PR so that Larry can cut a release.

larrybabb added a commit that referenced this pull request Mar 14, 2025
@larrybabb
Merge PR #121 120 add figures to documentation
4c51d53
larrybabb added a commit that referenced this pull request Mar 14, 2025
@larrybabb
Merge PR #121 120 add figures to documentation (#126)
788ddd3 
* Added how Cat-VRS works doc page
* Added new figure images
* added how-cat-vrs-works section
* Update docs/source/how_cat-vrs-works.rst

---------
Co-authored-by: Brendan Reardon <[email protected]>
Co-authored-by: Daniel Puthawala <[email protected]>
Co-authored-by: Kori Kuzma <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brendanreardon brendanreardon brendanreardon approved these changes

@korikuzma korikuzma korikuzma requested changes

@larrybabb larrybabb larrybabb approved these changes

Assignees

@DanielPuthawala DanielPuthawala

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add figures on what Cat-VRS can do to documentation
5 participants
@DanielPuthawala @jsstevenson @larrybabb @brendanreardon @korikuzma