Skip to content
Public template

About

No description, website, or topics provided.

Resources

Contributing

Stars

1 star

Watchers

1 watching

Forks

Repository files navigation

TIDA Specification Template

See the template live: 📄 Web page · 📥 PDF

The pages you see there are produced by this repository — they double as the template's documentation, explaining and demonstrating how to write a spec.

Starting a new specification? Follow WG-ONBOARDING.md. Once your repo is created, replace the text of this README with a short description of your specification (what it is, its status, and a link to its published site).


A specification for the FG-TIDA working groups, authored with the shared TIDA template: one source that builds a modern web page and a print-ready PDF, with support for diagrams and auto-generated API references.

Quick start

  1. In your Working Group's GitHub organization (fg-tida-wg<n>), click Use this template → Create a new repository, named wg<n>-<acronym>-<spec-name>.
  2. In the new repo: Settings → Pages → Source: GitHub Actions.
  3. Edit the content under src/doc/ — replace the <placeholders> and the example text. Full instructions are in WG-ONBOARDING.md.
  4. Push to main. The site and PDF publish automatically to https://fg-tida-wg<n>.github.io/<repo-name>/.

In this repository

  • src/doc/index.rst — the document front matter (title, abstract, authors…).
  • src/doc/chapters/ — the chapters; they explain and demonstrate how to write content, then you replace them with your own.
  • CONTRIBUTING.md — how to contribute, and how to build, preview, and customise the document.
  • WG-ONBOARDING.md — the full step-by-step guide for authors.

Built on the open-source CUTEspecs template.

About

No description, website, or topics provided.

Resources

Contributing

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages

Generated from debora-com/CUTEspecs