#690: Quick start guidance#693
Open
brendanreardon wants to merge 8 commits into
Open
Conversation
…en I attempt pre-commit hooks
- Expanded quickstart.rst with repo overview, notebooks link, examples, and community info - Added getting_involved.rst with VRS-specific community links - Added getting_involved to index toctree Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Author
|
After reviewing, I am still happy with the content of this PR |
larrybabb
added
the
public review ready
ahwagner
reviewed
Jun 29, 2026
ahwagner
left a comment
ahwagner
left a comment
Member
There was a problem hiding this comment.
I haven't reviewed these in detail (time) but am concerned that the examples may not validate; is that tested? Sorry to be obtuse here.
Author
It looks like this repo's test pass within the fork (vrs) breardon@pomegranate:vrs-connect-hackathon$ pytest tests
==================================================== test session starts =====================================================
platform darwin -- Python 3.12.13, pytest-9.1.1, pluggy-1.6.0
rootdir: /Users/brendan/vrs-connect-hackathon
configfile: setup.cfg
plugins: anyio-4.14.1
collected 6 items
tests/test_basic.py ..... [ 83%]
tests/test_examples.py . [100%]
===================================================== 6 passed in 1.22s ======================================================With that said though, the examples are compiled into JSON directly from the existing YAML, so if they did not validate that would be an issue independent from this PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Link to the corresponding Issue
Summary of the Pull Request
Our goal with this hackathon was the improve the Quickstart experience for people onboarding into Cat-VRS. This is a Pull Request consisting of contributions from @DanielPuthawala , @melissacline , and myself from the Hackathon at 2026 Connect. Changes consist of: