diff --git a/.codesandbox/tasks.json b/.codesandbox/tasks.json index 957eedb..0a72550 100644 --- a/.codesandbox/tasks.json +++ b/.codesandbox/tasks.json @@ -8,5 +8,10 @@ ], // These tasks can be run from CodeSandbox. Running one will open a log in the app. - "tasks": {} + "tasks": { + "ruby:typecheck": { + "name": "Typecheck", + "command": "solargraph typecheck" + } + } } diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..964d46f --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,22 @@ +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +// README at: https://github.com/devcontainers/templates/tree/main/src/jekyll +{ + "name": "Jekyll", + // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile + "image": "mcr.microsoft.com/devcontainers/jekyll:2-bullseye" + + // Features to add to the dev container. More info: https://containers.dev/features. + // "features": {}, + + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + + // Uncomment the next line to run commands after the container is created. + // "postCreateCommand": "jekyll --version" + + // Configure tool-specific properties. + // "customizations": {}, + + // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. + // "remoteUser": "root" +} diff --git a/.github/dependabot.yml b/.github/dependabot.yml index ff1a325..f33a02c 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,8 +1,12 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for more information: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates +# https://containers.dev/guide/dependabot + version: 2 updates: - - package-ecosystem: bundler - directory: / - schedule: - interval: daily - allow: - - dependency-type: direct + - package-ecosystem: "devcontainers" + directory: "/" + schedule: + interval: weekly diff --git a/Gemfile b/Gemfile index f853790..fc1db26 100644 --- a/Gemfile +++ b/Gemfile @@ -13,4 +13,5 @@ group :jekyll_plugins do gem "jekyll-sitemap" gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 gem "base64", "~> 0.2.0" + gem 'csv' end \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock index 8bafb9a..027056b 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -7,6 +7,7 @@ GEM bigdecimal (3.2.2) colorator (1.1.0) concurrent-ruby (1.3.5) + csv (3.3.5) em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) @@ -20,12 +21,16 @@ GEM faraday-retry (2.3.2) faraday (~> 2.0) ffi (1.17.2-arm64-darwin) + ffi (1.17.2-x64-mingw-ucrt) ffi (1.17.2-x86_64-darwin) ffi (1.17.2-x86_64-linux-gnu) forwardable-extended (2.6.0) google-protobuf (4.31.1-arm64-darwin) bigdecimal rake (>= 13) + google-protobuf (4.31.1-x64-mingw-ucrt) + bigdecimal + rake (>= 13) google-protobuf (4.31.1-x86_64-darwin) bigdecimal rake (>= 13) @@ -96,9 +101,12 @@ GEM rexml (3.4.1) rouge (4.6.0) safe_yaml (1.0.5) - sass-embedded (1.89.2) + sass-embedded (1.89.2-arm64-darwin) + google-protobuf (~> 4.31) + sass-embedded (1.89.2-x86_64-darwin) + google-protobuf (~> 4.31) + sass-embedded (1.89.2-x86_64-linux-gnu) google-protobuf (~> 4.31) - rake (>= 13) sawyer (0.9.2) addressable (>= 2.3.5) faraday (>= 0.17.3, < 3) @@ -110,11 +118,13 @@ GEM PLATFORMS arm64-darwin + x64-mingw-ucrt x86_64-darwin x86_64-linux DEPENDENCIES base64 (~> 0.2.0) + csv faraday-retry jekyll (~> 4.3.2) jekyll-github-metadata (>= 2.15) diff --git a/_config.yml b/_config.yml index 8708010..e1a3322 100644 --- a/_config.yml +++ b/_config.yml @@ -45,7 +45,7 @@ search: # Supports true or false (default) button: true # Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS) - focus_shortcut_key: 'k' + focus_shortcut_key: "k" # For copy button on code enable_copy_code_button: true @@ -69,8 +69,8 @@ heading_anchors: true # Aux links for the upper right navigation aux_links: - "BIRDSOpenSource on GitHub": - - "{{site.github_org}}" + "GitHub": + - "https://github.com/BIRDSOpenSource/BIRDSOpenSource.github.io" # Makes Aux links open in a new tab. Default is false aux_links_new_tab: true @@ -83,7 +83,7 @@ nav_enabled: true color_schemes: - light - dark - + color_scheme: dark # # Define Jekyll collections @@ -104,7 +104,7 @@ callouts: title: Warning color: red opacity: 0.3 - + caution: title: Caution color: yellow diff --git a/_includes/head.html b/_includes/head.html index d7ce03c..1f9ad7a 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -1,51 +1,159 @@ - - - - - - {% if site.ga_tracking != nil %} - {% assign ga_tracking_ids = site.ga_tracking | split: "," %} - - - {% endif %} + + + + + + + + {% if site.ga_tracking != nil %} {% assign ga_tracking_ids = site.ga_tracking + | split: "," %} + + + {% for ga_property in ga_tracking_ids %} + gtag('config', '{{ ga_property }}'{% unless site.ga_tracking_anonymize_ip == nil %}, { 'anonymize_ip': true }{% endunless %}); + {% endfor %} + + {% endif %} {% if site.search_enabled != false %} + {% endif %} - + - {% for file in site.static_files %} - {% if file.path == site.favicon_ico or file.path == '/favicon.ico' %} - {% assign favicon = true %} - {% endif %} - {% endfor %} - {% if favicon %} - + {% for file in site.static_files %} {% if file.path == site.favicon_ico or + file.path == '/favicon.ico' %} {% assign favicon = true %} {% endif %} {% + endfor %} {% if favicon %} + {% endif %} - + - + {%- seo title=false -%} {{ site.data.l10n.title }} {% include head_custom.html %} + diff --git a/_includes/nav_footer_custom.html b/_includes/nav_footer_custom.html index 440b90d..dfa8bce 100644 --- a/_includes/nav_footer_custom.html +++ b/_includes/nav_footer_custom.html @@ -1,19 +1,16 @@ - -{%- assign date_format = site.data.l10n.date_format | default: "%b %-d, %Y" -%} -{{ site.time | date: date_format }} {{ site.data.l10n.title }} -
-

- Using Just the Docs -

-

- - Built with ❤️ by Kyutech LaSEINE - -

-
+ + {%- assign date_format = site.data.l10n.date_format | default: "%b %-d, %Y" + -%} {{ site.time | date: date_format }} {{ site.data.l10n.title }} +
+

Using Just the Docs

+

+ + Built with ❤️ by Kyutech LaSEINE + +

+
- diff --git a/_site/index.html b/_site/index.html index 22eefd4..028980a 100644 --- a/_site/index.html +++ b/_site/index.html @@ -1 +1 @@ - BIRDS BUS Open Source | Docs Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Jul 29, 2025 BIRDS BUS Open Source | Docs

Using Just the Docs

Built with ❤️ by Kyutech LaSEINE

An Open Source Bus System for Academic Satellites

Everything you need to build a satellite

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.

Explore the BIRDS bus and start building:

  • Learn the basics and architecture
  • Get started with guides and tools
  • Deep-dive into hardware and software
  • Contribute and collaborate

Getting Started

New to BIRDS? These guides introduce you to the bus' core concepts and link you to further tutorials.

Read the Getting Started Guide

Hardware Guide

In-depth documentation of physical components in the BIRDS bus with technical background and usage tips.

Open the Hardware Guide

Software Guide

Understand the software powering the BIRDS system, including coding guidelines, examples, and architecture.

Explore the Software Guide

Contributor's Guide

Found a typo? Have ideas for improvement? Learn how to contribute to the BIRDS Open Source ecosystem.

Contribute to the Project

Project Details

See what's new in the latest release, track changelog updates, and view overall project roadmap.

View Project Details

Looking for something specific? Use the search bar at the top — or open an issue to let us know!

+ BIRDS BUS Open Source | Docs Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Aug 18, 2025 BIRDS BUS Open Source | Docs

Using Just the Docs

Built with ❤️ by Kyutech LaSEINE

An Open Source Bus System for Academic Satellites

Everything you need to build a satellite

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.

Explore the BIRDS bus and start building:

  • Learn the basics and architecture
  • Get started with guides and tools
  • Deep-dive into hardware and software
  • Contribute and collaborate

Getting Started

New to BIRDS? These guides introduce you to the bus' core concepts and link you to further tutorials.

Read the Getting Started Guide

Hardware Guide

In-depth documentation of physical components in the BIRDS bus with technical background and usage tips.

Open the Hardware Guide

Software Guide

Understand the software powering the BIRDS system, including coding guidelines, examples, and architecture.

Explore the Software Guide

Contributor's Guide

Found a typo? Have ideas for improvement? Learn how to contribute to the BIRDS Open Source ecosystem.

Contribute to the Project

Project Details

See what's new in the latest release, track changelog updates, and view overall project roadmap.

View Project Details

Looking for something specific? Use the search bar at the top — or open an issue to let us know!

diff --git a/assets/svg/github.svg b/assets/svg/github.svg new file mode 100644 index 0000000..dcfd5cd --- /dev/null +++ b/assets/svg/github.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/index.en.md b/index.en.md index ecab6c4..377ae9e 100644 --- a/index.en.md +++ b/index.en.md @@ -8,13 +8,15 @@ lang: en --- ### **{{site.tagline}}** -{: .lh-0 .text-blue-000} -# Everything you need to build a satellite + + +# Everything you need to build a satellite {{site.description}} Explore the BIRDS bus and start building: + - [x] Learn the basics and architecture - [x] Get started with guides and tools - [x] Deep-dive into hardware and software @@ -87,4 +89,4 @@ Explore the BIRDS bus and start building: --- -Looking for something specific? Use the search bar at the top — or [open an issue](https://github.com/{{site.github_repo}}/issues) to let us know! \ No newline at end of file +Looking for something specific? Use the search bar at the top — or [open an issue](https://github.com/{{site.github_repo}}/issues) to let us know!