/fsd-doc

An unofficial attempt at docmenting FSD, the protocol behind IVAO and VATSIM.

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

FSD documentation

An unofficial attempt at documenting the implementations of FSD used today. IVAO and VATSIM happen to be the most common ones, though there are likely others.

The documentation can be viewed here: https://fsd-doc.norrisng.ca/

NOTE: the original link at https://studentweb.uvic.ca/~norrisng/fsd-doc/ is no longer accessible. Please update your links, bookmarks, favourites, URLs, BBQs, etc etc.

Editing and building the site

Individual pages can be edited using your favourite text or Markdown editor.

The entire documentation uses MkDocs. To build the site into static HTML files:

sudo apt-get install mkdocs
cd fsd-doc
mkdocs build

This creates a directory named site/. The index page is located at site/index.html.

To see a live preview while editing, run the following:

mkdocs serve

Once running, the preview can be viewed at http://localhost:8000.

The table of contents on the left is controlled by mkdocs.yml. To edit it, please refer to the official MkDocs documentation.

Contributing

Feel free to fork and create a pull request!