ObolNetwork / ObolNetwork/obol-docs
Incorporate Public Feedback in the docs
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 moderators are collection FAQs from their interactions on the Public Discord. These have been categorized in the below table.
🛠️ Proposed solution
For the issues which have Review by TPM = Yes and Integrated into docs = No, they need to be added in various places in the docs.
https://www.notion.so/obol-dvt/71f621ef0b144829af18d194153e240f?v=ce86be9e6a6643e982cb784c10b1ccc6
🧪 Tests
- Netlify deployment build tests passing
👐 Additional acceptance criteria
- Make sure we don't create more places for FAQ, it should be as centralized as possible
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 categorized FAQ table in the linked Notion page, filtering for entries marked “Review by TPM” = “Yes” and “Integrated into docs” = “No”. Locate the appropriate existing documentation sections, keeping FAQ content centralized rather than creating new FAQ locations. Confirm the Netlify deployment build passes when the documentation updates are complete.
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
- Mostly clear
- Newbie friendliness
- 35/100