Documentation of Reline
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 311
- Forks
- 99
- Avg merge
- 6d 4h
- Merged PRs (30d)
- 1
Description
ref https://github.com/ruby/reline/pull/552#issuecomment-1793445051
Our team has been working on quite a lot of development, to the point where we need to start writing some documents.
Where to doc?
candidates:
- README.md
Simplest way. As the number of descriptions increases, the file may become harder to read - doc/reline/*md
like https://github.com/ruby/csv/tree/master/doc/csv
I prefer the latter.
What to doc?
- Reline.autocompletion
- Reline.dig_perfect_match_proc
- Reline.output_modifier_proc
- Reline.completion_proc
- Reline::Face
any other things?
How to doc?
- Markdown --- I think everyone will agree
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the referenced discussion and compare README.md with the doc/reline/*md layout, using the existing doc/csv structure as a guide. Identify the relevant behavior and public API details for Reline.autocompletion, Reline.dig_perfect_match_proc, Reline.output_modifier_proc, Reline.completion_proc, and Reline::Face. Done means the agreed Reline documentation is written in Markdown in the selected location, with any additional scope resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100