Merge pull request #5 from BIRDSOpenSource/development

Development

Author: balotofi

.DS_Store

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: daily
+    allow:
+      - dependency-type: direct

.github/dependabot.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+    
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3' # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+      - name: Build with Jekyll
+        run: bundle exec jekyll build

.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll site to Pages
+
+on:
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3' # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        # Outputs to the './_site' directory by default
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/pages.yml

@@ -1,2 +1,15 @@
+# Not sure what a .gitignore is?
+# See: https://git-scm.com/docs/gitignore
 
-*.pdf
+# These are directly copied from Jekyll's first-party docs on `.gitignore` files:
+# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control
+
+# Ignore the default location of the built site, and caches and metadata generated by Jekyll
+_site/
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+
+# Ignore folders generated by Bundler
+.bundle/
+vendor/

.gitignore

@@ -1,10 +1,11 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/BIRDSOpenSource/BIRDSOpenSource.github.io" }
-
-gem 'jekyll-theme-minimal'
+gem "jekyll", "~> 4.3.2" # installed by `gem jekyll`
+gem "just-the-docs", "0.5.4" # pinned to the current release
+# gem "just-the-docs"        # always download the latest release
 
 group :jekyll_plugins do
-  gem "jekyll-sitemap"
-  gem "jekyll-seo-tag"
+    gem "jekyll-polyglot"
+    gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2
+    gem "base64", "~> 0.2.0"
 end

Gemfile

@@ -3,30 +3,23 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    bigdecimal (3.1.8)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
     colorator (1.1.0)
     concurrent-ruby (1.3.4)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
     eventmachine (1.2.7)
-    ffi (1.17.0)
-    ffi (1.17.0-arm64-darwin)
-    ffi (1.17.0-x86_64-darwin)
+    ffi (1.17.1-arm64-darwin)
     forwardable-extended (2.6.0)
-    google-protobuf (4.27.3)
-      bigdecimal
-      rake (>= 13)
-    google-protobuf (4.27.3-arm64-darwin)
-      bigdecimal
-      rake (>= 13)
-    google-protobuf (4.27.3-x86_64-darwin)
+    google-protobuf (4.29.3-arm64-darwin)
       bigdecimal
       rake (>= 13)
     http_parser.rb (0.8.0)
-    i18n (1.14.5)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
-    jekyll (4.3.3)
+    jekyll (4.3.4)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -42,19 +35,20 @@ GEM
       safe_yaml (~> 1.0)
       terminal-table (>= 1.8, < 4.0)
       webrick (~> 1.7)
+    jekyll-polyglot (1.8.1)
+      jekyll (>= 4.0, >= 3.0)
     jekyll-sass-converter (3.0.0)
       sass-embedded (~> 1.54)
     jekyll-seo-tag (2.8.0)
       jekyll (>= 3.8, < 5.0)
-    jekyll-sitemap (1.4.0)
-      jekyll (>= 3.7, < 5.0)
-    jekyll-theme-minimal (0.2.0)
-      jekyll (> 3.5, < 5.0)
-      jekyll-seo-tag (~> 2.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (2.4.0)
-      rexml
+    just-the-docs (0.5.4)
+      jekyll (>= 3.8.5)
+      jekyll-seo-tag (>= 2.0)
+      rake (>= 12.3.1)
+    kramdown (2.5.1)
+      rexml (>= 3.3.9)
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liquid (4.0.4)
@@ -69,44 +63,26 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rexml (3.3.6)
-      strscan
-    rouge (4.3.0)
+    rexml (3.4.0)
+    rouge (4.5.1)
     safe_yaml (1.0.5)
-    sass-embedded (1.77.8)
-      google-protobuf (~> 4.26)
+    sass-embedded (1.83.1)
+      google-protobuf (~> 4.29)
       rake (>= 13)
-    sass-embedded (1.77.8-aarch64-mingw-ucrt)
-      google-protobuf (~> 4.26)
-    sass-embedded (1.77.8-arm64-darwin)
-      google-protobuf (~> 4.26)
-    sass-embedded (1.77.8-x86-cygwin)
-      google-protobuf (~> 4.26)
-    sass-embedded (1.77.8-x86-mingw-ucrt)
-      google-protobuf (~> 4.26)
-    sass-embedded (1.77.8-x86_64-cygwin)
-      google-protobuf (~> 4.26)
-    sass-embedded (1.77.8-x86_64-darwin)
-      google-protobuf (~> 4.26)
-    strscan (3.1.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    unicode-display_width (2.5.0)
-    webrick (1.8.1)
+    unicode-display_width (2.6.0)
+    webrick (1.9.1)
 
 PLATFORMS
-  aarch64-mingw-ucrt
   arm64-darwin
-  ruby
-  x86-cygwin
-  x86-mingw-ucrt
-  x86_64-cygwin
-  x86_64-darwin
 
 DEPENDENCIES
-  jekyll-seo-tag
-  jekyll-sitemap
-  jekyll-theme-minimal
+  base64 (~> 0.2.0)
+  jekyll (~> 4.3.2)
+  jekyll-polyglot
+  just-the-docs (= 0.5.4)
+  webrick
 
 BUNDLED WITH
    2.5.16

Gemfile.lock

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [2024] [The BIRDS Project]
+Copyright (c) 2022 just-the-docs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE.md renamed to LICENSE

@@ -1,3 +1,75 @@
-# Some info just to test
+# BIRDS Build-A-Satellite Documentation Site
 
-* Some stuff
+Welcome to the BIRDS Build-A-Satellite Documentation Site! This platform provides a comprehensive 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.
+
+## 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.
+
+### Key Features
+
+- **Step-by-Step Guides**: Detailed instructions covering each phase, from concept design to in-orbit operation.
+- **Hardware and Software Specifications**: Comprehensive information on components, materials, software, and libraries.
+- **Code Repositories**: Links to essential open-source codebases and development tools.
+- **Troubleshooting and FAQ**: Solutions to common issues and tips for overcoming challenges.
+- **Community Support**: Join our community to get advice, share experiences, and collaborate with other developers.
+
+## Getting Started
+
+### Prerequisites
+
+Before diving in, make sure you have the following:
+
+- Basic knowledge of electronics and programming.
+- Access to [List of Required Tools and Software, e.g., CAD software, programming languages].
+- Familiarity with Git and GitHub for accessing project repositories.
+
+### Setting Up
+
+1. **Clone the Repository**: Download the documentation repository to get started.
+   ```bash
+   git clone https://github.com/your-repo/satellite-docs.git
+   ```
+2. **Navigate the Site**: Explore our structured guides:
+   - [Design & Planning](#)
+   - [Component Selection](#)
+   - [Assembly & Testing](#)
+   - [Launch Preparations](#)
+
+3. **Join the Community**: Connect with other developers and contributors in our [Forum/Discord/Slack Channel].
+
+## Contributing
+
+We welcome contributions! Here’s how you can help:
+
+1. **Improve Documentation**: Submit updates to enhance clarity, correct errors, or add new sections.
+2. **Suggest Features**: Share your ideas to improve the documentation or add resources.
+3. **Report Issues**: Encountered a problem? Submit an issue on our GitHub page.
+
+### Contribution Guidelines
+
+Please refer to our [Contribution Guide](#) for more details on coding standards, branch naming conventions, and testing requirements.
+
+## Contact
+
+For questions, suggestions, or support, reach out to our team at [contact@projectemail.com](mailto:contact@projectemail.com) or join the [Community Forum](#).
+
+
+## Licensing and Attribution
+
+This repository is licensed under the [MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!
+
+
+----
+
+[Jekyll]: https://jekyllrb.com
+[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
+[GitHub Pages]: https://docs.github.com/en/pages
+[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
+[Bundler]: https://bundler.io
+[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
+[`jekyll-default-layout`]: https://github.com/benbalter/jekyll-default-layout
+[`jekyll-seo-tag`]: https://jekyll.github.io/jekyll-seo-tag
+[MIT License]: https://en.wikipedia.org/wiki/MIT_License
+[starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml
+[actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE