ObolNetwork / ObolNetwork/obol-docs
Keep FAQ Page Up-to-Date with Dev-Support Interactions
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 27
- Forks
- 61
- Avg merge
- 1h 22m
- Merged PRs (30d)
- 2
Description
🎯 Problem to be solved
The FAQ page (https://docs.obol.tech/docs/int/faq/general) needs to be regularly updated with new information based on customer interactions reported in the dev-support channel. This will ensure that the FAQ remains comprehensive and helpful for users.
🛠️ Proposed solution
- Monitor the dev-support channel for new customer interactions, questions, or issues that may require adding or updating information in the FAQ
- When a new customer interaction is reported, analyze the question or issue and determine if it should be added to the FAQ or if an existing FAQ entry needs to be updated
- If a new FAQ entry is required, draft the content clearly and concisely, focusing on providing a thorough explanation and resolution and make a new pull request to be reviewed.
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
Start by reviewing the current FAQ at https://docs.obol.tech/docs/int/faq/general and the relevant interactions in the dev-support channel. Determine which questions need new or revised entries, then draft the documentation and open a pull request for review. The issue has no defined completion point because the monitoring is ongoing.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100