tarantool / tarantool/tt

Generate man pages

Open
#102 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3sp documentation teamE
Dominant language
Go
Stars
113
Forks
18
Avg merge
4d 11h
Merged PRs (30d)
23

Description

As far as I understand, we can just generate man pages as described here. If I haven't missed something, we need to add this feature.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked Cobra man page documentation, then inspect tt's CLI command setup to find how commands are registered and where generated documentation belongs. Done means the utility can generate man pages for its commands and the result is documented or otherwise verifiable.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.