rhventures / rhventures/react-native-dropdown-selector
Documentation: Move documentation from GitHub Wiki to an indexable platform
Open
@egeakman is already working on this.
Since Mar 12, 2025.
documentation
- Dominant language
- TypeScript
- Stars
- 4
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
- GitHub wikis are not indexed, meaning users cannot find our documentation through search engines. Instead, they must already know we have wikis. In contrast, Read the Docs is indexed and appears in search results.
- Read the Docs provides built-in statistics, and we can also integrate non-invasive analytics services like Plausible. Additionally, it offers multiple theme options, enhancing customization.
Using reStructuredText with Sphinx enables nice features such as internal referencing, which would improve documentation structure and navigation.Markdown could be used as well. See this and this.- Read the Docs allows broader contributions, unlike GitHub wikis, where only users with specific permissions can edit or suggest changes. Hosting documentation in the repository makes it accessible for pull requests.
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.
Assessment
This issue has not been assessed yet.