polish the prose
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 2
- Forks
- 0
- Avg merge
- 2h 8m
- Merged PRs (30d)
- 49
Description
The prose (README, docs, help text) should get a once-over pass to clarify, simplify, and make sure it's consistent (consistentify?).
For example, markfluence diff --help has this choice sentence:
FILE is one markdown file, and its page comes from its own page_id or
from its entry in markfluence.yaml's pages: block. One file, not a glob:
a diff over a whole tree is output nobody reads.
It'd be better as something like:
FILE is a single markdown file. The page_id for the Confluence page
is determined from frontmatter or markfluence.yaml file.
This covers reviewing and editing all the prose.
Contributor guide
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
Start by reading the README and docs, then run markfluence diff --help to review the example wording in context. Check the prose for clarity, simplicity, and consistency across the README, documentation, and help text; done means the edited text is consistent throughout.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100