README's Documentation section: stray Excel paragraph and a stale page list
Maintainers usually reply within 1 day
Nobody has claimed this yet.
- #197 by @yff124 — closed without merging
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 84/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- documentation
Research direction
Start with the Documentation sections in README.md, README.zh-CN.md, and docs/README.md, then compare their page links and titles with docs/site/manifest.json. Remove the unrelated Excel paragraph and make each list include every manifest page under its manifest title. Done when all three lists match the manifest and the extra paragraph is gone.
Written by the indexing model from the issue text.
Description
The README's Documentation section has two problems.
- A stray paragraph. Between "The documentation is at taskuary.com/docs" and the list of pages sits a changelog-style note about Excel reports keeping columns with repeated or blank headers. It belongs on the reports docs page, or nowhere.
README.zh-CN.mdcopies it. - A stale page list. It links "Reports and the Assistant", but the page is titled "Reports and the Advisor" in
docs/site/manifest.json. It also leaves out four pages the manifest has: Assistant buttons, What the Assistant sees, On your phone and When something is wrong.docs/README.mdlikewise lacks the two Assistant pages.
Where: README.md and README.zh-CN.md (Documentation section), docs/README.md
Done when the Documentation lists in both READMEs and in docs/README.md show every page in docs/site/manifest.json under its manifest title, with no unrelated paragraph in between.
Getting started: pip install -e ".[dev]", then python -m pytest -q (offline). UI work: cd website && npm ci && npm test. See CONTRIBUTING.md. One small PR with the change (and its test, where there is one) is perfect.
- Dominant language
- Python
- Stars
- 116
- Forks
- 22
- Avg merge
- 13h 39m
- Merged PRs (30d)
- 51
Getting set up
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.
More from ldbumble/taskuary
-
accessibility good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 92/100
ldbumble/taskuary#161 · 1 comment ·
Maintainers usually reply within 1 day
-
"re-check CI" is a span, and its busy state is colour-onlyMay be free again A pull request for this issue was closed without being merged. Openaccessibility good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Settings flag chips and channel chips cannot be used from the keyboardMay be free again A pull request for this issue was closed without being merged. Openaccessibility good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
ldbumble/taskuary#147 · 1 comment ·
Maintainers usually reply within 1 day
-
Four Cancel/Dismiss buttons are lowercase while the rest are capitalisedPossibly taken @krishna2707 claimed this 2 days ago. Openenhancement good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 87/100
ldbumble/taskuary#143 · 1 comment ·
Maintainers usually reply within 1 day
All issues in ldbumble/taskuary
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Deltares/imod-python#1940 ·
Maintainers usually reply within 1 day
-
effort: low prio: low ready
Difficulty 1/5 Under an hour Newbie friendliness 82/100
digitalfabrik/integreat-cms#4621 ·
Maintainers usually reply within 5 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
ioos/compliance-checker#1375 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day