Skip to content

Update README in favour of docs site#560

Merged
camspec merged 4 commits intomainfrom
cameron/update-readme
Sep 26, 2025
Merged

Update README in favour of docs site#560
camspec merged 4 commits intomainfrom
cameron/update-readme

Conversation

@camspec
Copy link
Member

@camspec camspec commented Sep 24, 2025

Purpose

Heavily cut down on README content as part of the transition to the docs website. Some guides were outdated or incorrect, while others were formatted inconsistently. These changes are present on the docs site.

New Changes

  • Added the UW Orbital Docs section to the top of the document to highlight that it contains essential sub-team information
  • Deleted large sections of the README, including the setup guides, build guides, and style guides, which are now found on the documentation website
  • Made some minor formatting changes to some remaining sections
  • Removed "Back to top" hyperlinks since the document is short enough now
  • Updated the name of the team from firmware to software
  • Added Notion section and links to useful pages

@github-actions
Copy link

Pull reviewers stats

Stats of the last 120 days for UWOrbital:

User Total reviews Time to review Total comments
Adityya-K 24 20h 4m 92
kepler452b123 17 4d 1h 1m 74
camspec 10 17h 17m 68
Yarik-Popov 8 1d 4h 42m 65
Navtajh04 6 5d 1h 23m 68

⚡️ Pull request stats

Copy link
Contributor

@kepler452b123 kepler452b123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@camspec camspec merged commit 70e5539 into main Sep 26, 2025
49 checks passed
@camspec camspec deleted the cameron/update-readme branch September 26, 2025 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants