https://github.com/team401/docs

Documentation site for Team 401
https://github.com/team401/docs

documentation frc

Last synced: 5 days ago
JSON representation

Documentation site for Team 401

• Host: GitHub
• URL: https://github.com/team401/docs
• Owner: team401
• License: gpl-3.0
• Created: 2019-05-09T19:06:15.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-06T18:13:03.000Z (6 days ago)
• Last Synced: 2025-01-06T19:28:03.871Z (6 days ago)
• Topics: documentation, frc
• Language: Ruby
• Homepage: https://team401.github.io/Docs/
• Size: 14.9 MB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# 401 Docs

401 Docs was started in the summer of 2019 and is an ongoing effort to improve Team 401 by documenting our procedures and experiences. 

# Contributing

To contribute to 401 Docs please open a pull request.

## Running Locally

To ensure that changes made behave as expected, it is recommended to run the website locally before making a pull request. Steps to do this:

1. Install the latest version of Ruby: [link](https://www.ruby-lang.org/en/downloads/)

2. Open a command line / terminal and navigate to this project's location in the filesystem.

3. Run `bundle install` to install dependencies

4. Run `bundle exec jekyll serve` to run the website and serve it at `localhost:4000`

Putting `localhost:4000` into the URL bar of a web browser will show the website in its current state as long as it is being served. Use `Ctrl+C` to stop serving the website locally. Any changes made to the website will be automatically applied after refreshing the page while the pages are being served.

> Note: Steps 1 and 2 only need to be completed once.

# Troubleshooting

## The website contents aren't updating.

- There may be weird things happening with the compilation. Delete the generated `_site` folder and re-run the `bundle exec jekyll serve` to regenerate the website pages.

- Try a deep refresh of the page to make sure it isn't just the cache.

## The Github Action isn't working

- If you get an error about the version of Ruby/Bundler not supporting Linux, try the following command

```

bundle lock --add-platform x86_64-linux

```