Documentation: Update README.md

Open
#99 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
documentation

Research direction

Start with README.md and review the existing frontend setup section. Document the backend API setup, contacts, project compilation, and running the production app; it is done when a new member can follow the README through setup, building, and production use.

Written by the indexing model from the issue text.

Description

good first issue priority: low type: documentation

Description

Currently README is outdated and unhelpful for new members/ anyone who hasn't interacted with Dashboard.

  • Add concise yet informative intro section.
  • Add "getting started" section.
    • walks through front end setup.
    • walks through backend API set up.
  • Added Contacts section, @favillat for example.
  • Add a "building" section
    • walk through compiling project.
    • running said production app.
Dominant language
TypeScript
Stars
2
Forks
2
Avg merge
4d 10h
Merged PRs (30d)
3

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SunDevilRocketry/Flight-Software-GUI

All issues in SunDevilRocketry/Flight-Software-GUI

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.