abpframework / abpframework/abp
Add a way to collect feedback on the documents
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 14.4k
- Forks
- 3.7k
- Avg merge
- 15h 32m
- Merged PRs (30d)
- 106
Description
We may make mistakes on the documentation or a documentation may become outdated. In such cases, we can provide an easy and fast way to give feedback to us instead of waiting people to create a GitHub issue.
Adding a "feedback" or "I have an issue" button/action in every document would be a way, for example.
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 reviewing how the project's documentation is organized and published, since the issue does not identify files, tests, or an existing feedback mechanism. Define how a feedback or "I have an issue" action should appear on every document, where submissions should go, and consider the work done when readers can use it consistently across the documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100