Update docs #1412
Open
Update docs #1412
+89
−5
Conversation
This file contains 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
|
@mateoclarke I haven't forgotten about this one. thank you! i think this could be a good place to add cityofaustin/atd-data-tech#18869 too, and i'm starting to think that aligning our docs with John's snazzy new VZ docs would be a good idea. At least as an aspiration! |
|
@mddilley I caught up with @amenity a bit today and she pointed me to this Gitbook page she made for a non-dev audience in mind but it's pretty darn similar to what I'm proposing adding to the README. Not sure how we should consolidate these, but just wanted to make a note of it. |
mddilley
reviewed
Oct 15, 2024
|
|
||
|  | ||
|
|
||
| ## Getting Started for Developers |
There was a problem hiding this comment.
Could you update this heading to say Quick start like the VZ readme? I think it would be nice to align the way we document the two projects as much as possible.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I thought, if someone is at the codebase, we may as well give explicit instructions for installing the software. Instead of having to navigate through multiple pages of docs in Github, we can make it a little more user-friendly for new devs. This info is covered in the Gitbooks but I thought it could be more sequential.
Associated issues
cityofaustin/atd-data-tech#18869
Testing
N/A
Ship list