NatLabRockies / NatLabRockies/fastsim
Update docs to load vehicle from new database
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 60
- Forks
- 19
- Avg merge
- 10d 2h
- Merged PRs (30d)
- 2
Description
Getting Started still instructs the user to load a vehicle from the resources bundled with the FASTSim package. We should probably update this to point to the new vehicle database instead.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the Getting Started page linked in the issue and find the instructions for loading a vehicle from resources bundled with FASTSim. Update those instructions to point to the new vehicle database, then verify that the revised link and example are accurate.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 75/100