Update "Getting Started" and software architecture docs #3313
Conversation
…into update_docs
…into update_docs
docs/getting-started.md
Outdated
| 5. Clone your fork of the repository. We recommend cloning using HTTPS since it is the easiest to set up. You should be able to clone your fork using the following command (you can put it wherever you like): | ||
| ``` | ||
| git clone https://github.com/<your_username>/Software.git | ||
| ``` | ||
| You can find your fork's remote URL under the green `Code` button on the main page of your fork on GitHub, under the HTTPS tab. |
There was a problem hiding this comment.
we shouldn't show HTTPS cloning. You won't be able to push/pull because github doesn't do password authentication anymore.
There was a problem hiding this comment.
well... I use https and it's easy peasy. But I forgot that I have a credential helper (GitHub CLI). Once you run gh auth login GitHub opens up in your browser and prompts you to sign in with 2fa. Then your credentials are cached and push/pull via https never prompts you for credentials
There was a problem hiding this comment.
yes, you need to either set up:
- personal access tokens (mayhaps too complicated for new members)
- Or set up a credential helper. Then, we should mention git credential manager as an additional required download.
Considering all of this together, I think SSH should still be our recommendation but we can mention HTTPS.
There was a problem hiding this comment.
Ok, we can keep ssh as the default. I was just thinking of suggesting https since setting up ssh is not exactly straightforward either
| ```cpp | ||
| def executeStrategy(IntentCoroutine::push_type& yield, Pass pass) { | ||
| do { | ||
| yield(/* align the robot to make the pass */) | ||
| }while(current_time < pass.start_time); | ||
| } while(current_time < pass.start_time); | ||
| do { | ||
| yield(/* kick the ball at the pass location */) | ||
| }while(/* robot has not kicked the ball */) | ||
| } while(/* robot has not kicked the ball */) |
There was a problem hiding this comment.
a bit weird for us to show example code that doesn't follow our style guidelines
|
This PR is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 5 days. |
|
Made changes to our software architecture doc:
I'd like to update/add diagrams at some point but I think I will do that in a different PR. |
Description
Testing Done
Resolved Issues
Resolves #1854
Resolves #3312
Resolves #3126
Length Justification and Key Files to Review
Review Checklist
It is the reviewers responsibility to also make sure every item here has been covered
.hfile) should have a javadoc style comment at the start of them. For examples, see the functions defined inthunderbots/software/geom. Similarly, all classes should have an associated Javadoc comment explaining the purpose of the class.TODO(or similar) statements should either be completed or associated with a github issue