containers / containers/toolbox

Rationalise the docs

Open
#575 1 comment 0 reactions 0 assignees View on GitHub
2. Documentation 5. Help Wanted Project Pickle 🥒
Dominant language
Go
Stars
3.5k
Forks
262
Avg merge
3d 1h
Merged PRs (30d)
1

Description

Currently toolbox has three sets of documentation: the readme, the man page, and the [Silverblue docs page|https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/]. There's too much duplication here, and we should try and reduce the amount of documentation we're maintaining, in order to improve it.

We should maybe:

- [ ] retire the Silverblue docs page
- [ ] update the man page
- [ ] reuse the man page for the readme
- [ ] copy the readme to https://docs.fedoraproject.org/en-US/docs/

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.