crate / crate/crate-docs-theme

Expand "Authoring Guide"

Open
#637 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
22
Forks
6
PR merge metrics
No merged PRs in 30d

Description

## About

Going forward, the "Authoring Guide" wants to absorb more content, to maintain it all in a single place, and provide it nicely rendered.

- https://crate-docs-theme.readthedocs.io/en/latest/authoring.html

## Details

- Style Guide from `crate-docs:style/*.rst`
- Guidelines about utility support, e.g. about `linksmith`

## References

- https://github.com/crate/crate-docs/tree/main/style
- https://github.com/crate/crate-docs/issues/105
- https://github.com/crate/cratedb-guide/issues/372
- https://github.com/crate/tech-writing/blob/main/README.md
- https://github.com/crate/crate-docs-theme/blob/main/DEVELOP.rst

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.