/wiki

Atom Wiki site

Primary LanguagePython

Contributors Forks Stargazers Issues LinkedIn


Logo

Atom Wiki

This is the repo for the atom-robotics-lab website, a documentation site for the our Projects. The wiki's purpose is to “Provide documentation for our project" - visit our wiki. If you’re interested in helping to improve our wiki, find out how to contribute.
Our wiki »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Contact
  7. Acknowledgments

About The Project

This is the repo for the atom-robotics-lab website, a documentation site for the our Projects. The wiki's purpose is to “Provide documentation for our project" - visit our wiki. If you’re interested in helping to improve our wiki, find out how to contribute.

(back to top)

Built With

  • Sphinx
  • Python

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • Sphinx and some dependencies 
    cd ./wiki
pip install -r requirements.txt

Installation

  1. Clone the repo 
    git clone git@github.com:atom-robotics-lab/wiki.git
cd wiki
  2. To generate html files 
    make html
  3. Open _build/html/index.html in your browser

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

  • The conf.py file contains all the sphinx configuration.
  • All the .rst files are present in the /markdown dir.
  • Custom html templates can be found in the /_templates dir.

(back to top)

Roadmap

  • mdbook wiki
  • Sphinx migration
    • Fixing images sizes
    • Shifting from .md to .rst
    • Edit on wiki feature
    • Collapsible sidebar menu
    • Discarding use of Iframes
    • Fixing local path links
  • Wiki beautification
    • Adding Graphics
    • Discarding use of captions
    • Switching theme
    • Easy documentation navigation via sidebar
    • Adding projects tab
  • Documentation
    • Mr robot
    • Curve Tracer
    • Obstacle avoidance
    • Open Cv projects

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

For more info refer to contributing.md

(back to top)

Contact

Our Socials - Linktree - atom@inventati.org

Wiki Link: https://github.com/atom-robotics-lab/wiki

(back to top)

Acknowledgments

(back to top)