https://github.com/es-alexander/zola-docs-template

A repository source for documenting a software application
https://github.com/es-alexander/zola-docs-template

Last synced: about 1 month ago
JSON representation

A repository source for documenting a software application

• Host: GitHub
• URL: https://github.com/es-alexander/zola-docs-template
• Owner: ES-Alexander
• License: other
• Created: 2024-05-13T12:28:51.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-04T21:04:02.000Z (about 2 years ago)
• Last Synced: 2025-03-05T18:38:33.084Z (over 1 year ago)
• Language: JavaScript
• Size: 108 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Overview

This repository documents the {SOFTWARE} application.

The documentation is generated using the [Zola](https://www.getzola.org/) static site generator.

## Structure

The `main` branch of the repository is used to generate the documentation site, using content sourced as submodules from the `latest`, `beta`, and versioned branches.

## Contributing

New features should first be documented in `latest`, and subsequently branched into `beta` and a stable version toegther with the software release cycle.

Improved documentation for existing features should at least be added to `latest`, and ideally also cherry-picked into the existing `beta` and stable-versioned branches as relevant.

Detailed contribution information can be found in [CONTRIBUTING.md](CONTRIBUTING.md)

## License

This documentation is licensed under [CC BY-NC-SA 4.0 ](https://creativecommons.org/licenses/by-nc-sa/4.0/?ref=chooser-v1)