WWT User Manual: Source Code

This repository contains the source code for the WorldWide Telescope User Manual. The master branch of this repo gets published here:

https://docs.worldwidetelescope.org/user-manual/

If you’re just interested in the documentation itself, you should go to that website. If you’re interested in contributing to this documentation, you’ve come to the right place!

The WorldWide Telescope project uses an open governance model and is fiscally sponsored by NumFOCUS. Consider making a tax-deductible donation to help the project pay for developer time, professional services, travel, workshops, and a variety of other needs.

Quick Start for the Initiated

The manual is a static site written in CommonMark Markdown and processed with Zola. Zola is distributed as a single executable so it is ridiculously easy to install.

This repository is themed by referencing zola-wwtguide as a submodule, so upon first checkout you’ll have to run:

git submodule update --init

Once everything is set up, all you have to do is run

zola serve

to build the site and serve it locally for testing. The command zola check will check the build and verify that outgoing links are valid. Zola has lots of documentation.

Merges to master will be published automatically using WWT’s continuous deployment infrastructure.

Contributing

Contributions are welcome! If you’re new to the project, please see the WWT Contributors’ Guide and the WWT Code of Conduct. We operate with a standard fork-and-pull model.

Acknowledgments

Work on the WorldWide Telescope system has been supported by the American Astronomical Society (AAS), the .NET Foundation, and other partners. See the WWT user website for details.