boostorg / boostorg/msm

Refurbish the documentation

Open
#104 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
40
Forks
59
PR merge metrics
No merged PRs in 30d

Description

**Description**

The documentation is currently in a single file in docbook format. It would be nice to have it in a more "edit-friendly" format and structured across multiple files.

Goals:

- [x] Migrate the documentation to AsciiDoc & Antora
- [ ] Provide a PDF export
- [x] Generate a (doxygen, MrDocs?) API documentation
- [ ] Detect broken anchors automatically (https://docs.quarkiverse.io/quarkus-antora/dev/testing.html)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.