one-zero-eight / one-zero-eight/printers
Documentation refactor
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Describe the feature
Currently, the documentation is built in into the bot cumbersomely. We need the bot messages to be more friendly, especially the error messages
Suggested solution
Use alerts instead of messages where possible, decrease the duplicated information, make error messages more friendly and ask a user to try again
Additional context
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 locating where the Telegram bot's messages and error responses are assembled. Review the existing messages and the attached example to identify duplicated information, cases suitable for alerts, and places where users should be asked to try again. Done means the relevant bot responses are friendlier and less repetitive, with alerts used where appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100