Update documentation

The documentation lives in the public GitHub repository antenna-docs. To suggest updates, you first need a GitHub account. Once logged in, you can start open pull requests to add or update articles. All contributions are much appreciated!

Articles are written in Markdown format. There are currently 2 main categories of articles. The User Guide includes articles for Antenna users. The Developer Guide includes articles for Antenna contributors.

Tip

Do you need a quick reference to the Markdown syntax? Checkout this Markdown Cheat Sheet!

Add a new article

  1. Go to the folder user-guide or dev-guide
  2. Add a new file to the folder. Make sure it uses the Markdown extension, for example new-article.md.
  3. Write the article
  4. To make the new article show up in the sidebar, add a row to mkdocs.yml
  5. Open a pull request with the changes

Update an existing article

  1. Go to the folder user-guide or dev-guide
  2. Locate the article and update it
  3. Open a pull request with the changes

Demo