Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ GEM
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
logger (1.6.5)
logger (1.6.6)
mercenary (0.4.0)
net-http (0.6.0)
uri
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

## About the Project

BIRDS-OSP is dedicated to empowering individuals, research groups, and educational institutions with limited resources to embark on satellite missions. This documentation is designed for those aiming to understand and develop a satellite from the ground up, focusing on open-source tools and affordable methods for accessible satellite technology.
BIRDSOpenSource is dedicated to empowering individuals, research groups, and educational institutions with limited resources to embark on satellite missions. This documentation is designed for those aiming to understand and develop a satellite from the ground up, focusing on open-source tools and affordable methods for accessible satellite technology.

### Key Features

Expand Down Expand Up @@ -68,7 +68,7 @@ Please refer to our [Contribution Guide](#) for more details on coding standards

## Contact

For questions, suggestions, or support, reach out to our team at [contact@projectemail.com](mailto:contact@projectemail.com) or join the [Community Forum](#).
For questions, suggestions, or support, reach out to our team at [{{site.email}}]({{site.email}}) or join the [Community Forum](#).


## Licensing and Attribution
Expand Down
21 changes: 13 additions & 8 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# site settings

title: BIRDS | Open Source Release
description: The BIRDS Open Source Release is a comprehensive open source guide for designing, building, testing, and launching a small satellite. Whether you’re a beginner or an experienced developer, our documentation is structured to assist you at every stage of the satellite development process.
email: null
title: BIRDSOpenSource | Docs
tagline: An Open Source Bus System for Academic Satellites
description: The BIRDSOpenSource release is a comprehensive open source guide for designing, building, testing, and launching a small satellite. Whether you’re a beginner or an experienced developer, our resources are structured to assist you at every stage of the satellite development process.
email: birds_opensource@lean-sat.org
telegram: https://t.me/+D3BCqCmceQ41ZGFl
mailing_list: https://lean-sat.org/opensource/
youtube: https://www.youtube.com/@kyutechseic4187
github_org: https://github.com/BIRDSOpenSource

# theme

Expand Down Expand Up @@ -67,8 +72,8 @@ heading_anchors: true

# Aux links for the upper right navigation
aux_links:
"BIRDS-OSP on GitHub":
- "https://github.com/BIRDSOpenSource"
"BIRDSOpenSource on GitHub":
- "{{site.github_org}}"

# Makes Aux links open in a new tab. Default is false
aux_links_new_tab: true
Expand All @@ -89,9 +94,9 @@ Contribute to Docs <br/>
- <a href=\"https://birdsopensource.github.io/contribute\">Learn more</a> about how to get involved. <br/>
- <a href=\"https://github.com/orgs/BIRDSOpenSource/discussions/categories/general\">Submit feedback</a> to let us know how we can improve BIRDS Docs. <br/> <br/>
Join the Community <br/>
- <a href=\"https://t.me/+D3BCqCmceQ41ZGFl\">Chat With Us On Telegram</a> <br/>
- <a href=\"https://www.youtube.com/@kyutechseic4187\">Watch Us On YouTube</a> <br/>
- <a href=\"https://lean-sat.org/opensource/\">Join Our Monthly Webinars</a>"
- <a href=\"{{site.telegram}}\">Chat With Us On Telegram</a> <br/>
- <a href=\"{{site.youtube}}\">Watch Us On YouTube</a> <br/>
- <a href=\"{{site.mailing_list}}\">Join Our Monthly Webinars</a>"

# Footer last edited timestamp
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
Expand Down
2 changes: 1 addition & 1 deletion _data/en/l10n.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
lang_name: "English"
title: BIRDS | Open Source Release
title: BIRDSOpenSource | Docs
date_format: "%b %e, %Y"
File renamed without changes.
2 changes: 1 addition & 1 deletion _site/about/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _site/index.html

Large diffs are not rendered by default.

49 changes: 0 additions & 49 deletions get-started.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GS-Software
parent: What is BIRDS?
grand_parent: Home
grand_parent: Getting Started
layout: default
lang: en
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Antenna Board
parent: What is BIRDS?
grand_parent: Home
grand_parent: Getting Started
layout: default
lang: en
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Backplane Board
parent: What is BIRDS?
nav_order: 4
grand_parent: Home
grand_parent: Getting Started
layout: default
lang: en
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: BIRDS Bus
parent: What is BIRDS?
nav_order: 1
grand_parent: Home
grand_parent: Getting Started
layout: default
lang: en
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Communications Board
parent: What is BIRDS?
nav_order: 3
grand_parent: Home
grand_parent: Getting Started
layout: default
lang: en
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Front Access Board
parent: What is BIRDS?
nav_order: 5
grand_parent: Home
grand_parent: Getting Started
layout: default
lang: en
---
Expand Down
2 changes: 1 addition & 1 deletion overview/birds/index.md → getting-started/birds/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: What is BIRDS?
nav_order: 1
parent: Home
parent: Getting Started
has_children: true
has_toc: false
layout: default
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: On Board Computer Board
parent: What is BIRDS?
nav_order: 2
grand_parent: Home
grand_parent: Getting Started
layout: default
lang: en
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Rear Access Board
parent: What is BIRDS?
grand_parent: Home
grand_parent: Getting Started
layout: default
lang: en
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Solar Panel Board
parent: What is BIRDS?
grand_parent: Home
grand_parent: Getting Started
layout: default
lang: en
---
Expand Down
14 changes: 10 additions & 4 deletions overview/before-you-start.md → getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
---
title: Before you start
title: Getting Started
nav_order: 3
parent: Home
has_children: true
layout: default
permalink: "/get-started"
lang: en
---

# Before You Start

# Getting Started
To ensure a smooth journey in building your CubeSat, there are a few things you'll want to understand beforehand. This section outlines key knowledge areas you'll need, from using the platform and GitHub to understanding systems engineering principles.

---

## Platform Basics: GitHub and Git
To work with Build-A-Sat, you'll need a GitHub account. This is where you'll manage your codebase and contribute to open-source satellite projects. Here’s a quick guide to get you started:
To work with BIRDS, you'll need a GitHub account. This is where you'll manage your codebase and contribute to open-source satellite projects. Here’s a quick guide to get you started:

### 1. **GitHub Account**
- Create a [GitHub account](https://github.com/) to access repositories, contribute to projects, and manage your code.
Expand Down Expand Up @@ -136,3 +138,7 @@ With this foundational knowledge, you’ll be better equipped to dive into the s
[Preliminary Design Review (PDR)]: {{site.url}}/project-managers/milestones/pm-pdr.html
[Critical Design Review (CDR)]: {{site.url}}/project-managers/milestones/pm-cdr.html
[Flight Readiness Review (FRR)]: {{site.url}}/project-managers/milestones/pm-frr.html


[Previous]({{site.url}}/get-started){: .btn .btn-purple }
[Next]({{site.url}}/get-started/reference.html){: .btn}
4 changes: 2 additions & 2 deletions gsoc/application-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ A great GSoC proposal should:
📌 **Submit Early** – Avoid last-minute issues!
📌 **Follow Up** – Stay engaged and show your enthusiasm

📨 **Need Help? [Contact Us!](https://t.me/+D3BCqCmceQ41ZGFl)**
📨 **Need Help? [Contact Us!]({{site.telegram}})**
📌 **GitHub Discussions:** [BIRDS Open Source](https://github.com/orgs/BIRDSOpenSource/discussions)
📌 **Email:** birds_opensource@lean-sat.org
📌 **Email:** {{site.email}}

🚀 **We look forward to your application! Good luck!**
16 changes: 4 additions & 12 deletions gsoc/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: GSoC
nav_order: 1
nav_order: 9
has_children: true
has_toc: false
layout: default
permalink: "/gsoc"
lang: en
Expand Down Expand Up @@ -53,14 +54,5 @@ BIRDS Open Source is a **collaborative CubeSat development community** that emer

---

## 📩 Get in Touch!
Have questions? We're happy to help!

📌 **Join Our Community:** Slack (coming soon) / [Forum Link](https://lean-sat.org/opensource/) <br />
📌 **Email Us:** birds_opensource@lean-sat.org <br />
📌 **GitHub:** [BIRDS Open Source](https://github.com/BIRDSOpenSource) <br />


---

🚀 **Ready to launch your open-source journey?** **Join us for GSoC 2025 and help shape the future of CubeSat development!**
## [📩 Get in Touch!](mailto:{{site.email}})
Have questions? We're happy to help!
83 changes: 83 additions & 0 deletions index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: Home
nav_order: 2
layout: home
has_toc: false
permalink: "/"
lang: en
---

### **{{site.tagline}}**
{: .lh-0 .text-purple-200}
# Everything you need to build a satellite

{{site.description}}

Here's what you can expect:
- [x] Introduction to the BIRDS bus and other core components
- [x] How to get started
- [x] Deep dives on technical topics


<div style="display: flex; flex-wrap: wrap; gap: 10px; justify-content: space-between;">
<div style="flex: 1 1 calc(50% - 10px); margin: 5px 0; padding: 10px; background-color: #f4f6fa; color: black; border-radius: 5px; box-sizing: border-box; box-shadow: 2px 2px 5px rgba(0, 0, 0, 0.1);">
<span class="fs-6" align="center">
<img src="https://www.svgrepo.com/show/9108/running-stick-figure.svg" width="50" height="50">
Getting Started </span>
<br />
<span class="fs-3"> New to BIRDS? Check out the getting started guides. They contain an introduction to the BIRDS bus’ main concepts and links to additional tutorials. </span>
<a href="{{site.url}}/get-started" style="display: block; margin-top: 5px; padding: 10px 0; background-color:rgb(0, 0, 0); color: white; text-decoration: none; text-align: center; border-radius: 3px; font-size: 12px; width: 100%; box-sizing: border-box;">
go to getting started guides
</a>
</div>


<div style="flex: 1 1 calc(50% - 10px); margin: 5px 0; padding: 10px; background-color: #f4f6fa; color: black; border-radius: 5px; box-sizing: border-box; box-shadow: 2px 2px 5px rgba(0, 0, 0, 0.1);">
<span class="fs-6" align="center">
<img src="https://www.svgrepo.com/show/326665/hardware-chip-outline.svg" width="50" height="50">
Hardware Guide </span>
<br />
<span class="fs-3"> The user hardware guide provides in-depth information on the key concepts of the physical components in the BIRDS bus with useful background information and explanation.
</span>
<br />
<a href="{{site.url}}/get-started" style="display: block; margin-top: 5px; padding: 10px 0; background-color:rgb(0, 0, 0); color: white; text-decoration: none; text-align: center; border-radius: 3px; font-size: 12px; width: 100%; box-sizing: border-box;">
to the user hardware guide
</a>
</div>


<div style="flex: 1 1 calc(50% - 10px); margin: 5px 0; padding: 10px; background-color: #f4f6fa; color: black; border-radius: 5px; box-sizing: border-box; box-shadow: 2px 2px 5px rgba(0, 0, 0, 0.1);">
<span class="fs-6" align="center">
<img src="https://www.svgrepo.com/show/525688/book-bookmark-minimalistic.svg" width="50" height="50">
Software Guide</span>
<br />
<span class="fs-3"> The user software guide provides in-depth information on the key concepts of the BIRDS bus software with useful background information and explanation. </span>
<a href="{{site.url}}/how-tos/write_board_specific_software.html" style="display: block; margin-top: 5px; padding: 10px 0; background-color:rgb(0, 0, 0); color: white; text-decoration: none; text-align: center; border-radius: 3px; font-size: 12px; width: 100%; box-sizing: border-box;">
to the user software guide
</a>
</div>

<div style="flex: 1 1 calc(50% - 10px); margin: 5px 0; padding: 10px; background-color: #f4f6fa; color: black; border-radius: 5px; box-sizing: border-box; box-shadow: 2px 2px 5px rgba(0, 0, 0, 0.1);">
<span class="fs-6" align="center">
<img src="https://www.svgrepo.com/show/525586/user-plus.svg" width="50" height="50">
Contributor’s Guide </span>
<br />
<span class="fs-3"> Saw a typo in the documentation? Want to improve existing functionalities? The contributing guidelines will guide you through the process of improving BIRDSOpenSource.
</span>
<a href="{{site.url}}/how-tos/write_board_specific_software.html" style="display: block; margin-top: 5px; padding: 10px 0; background-color:rgb(0, 0, 0); color: white; text-decoration: none; text-align: center; border-radius: 3px; font-size: 12px; width: 100%; box-sizing: border-box;">
to the contributor's guide
</a>
</div>

<div style="flex: 1 1 calc(100% - 10px); margin: 5px 0; padding: 10px; background-color: #f4f6fa; color: black; border-radius: 5px; box-sizing: border-box; box-shadow: 2px 2px 5px rgba(0, 0, 0, 0.1);">
<span class="fs-6" align="center">
<img src="https://www.svgrepo.com/show/486630/details.svg" width="50" height="50">
Project Details </span>
<br />
<span class="fs-3"> What’s new in the latest release, changelog, and other project details.
</span>
<a href="{{site.url}}/how-tos/write_board_specific_software.html" style="display: block; margin-top: 5px; padding: 10px 0; background-color:rgb(0, 0, 0); color: white; text-decoration: none; text-align: center; border-radius: 3px; font-size: 12px; width: 100%; box-sizing: border-box;">
to the project details
</a>
</div>
</div>
File renamed without changes.
Loading