rmosolgo / rmosolgo/graphql-ruby
Migrate to RDoc
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 5.4k
- Forks
- 1.4k
- Avg merge
- 23h 19m
- Merged PRs (30d)
- 28
Description
I love using the new Ruby docs with the Aliki theme. GraphQL-Ruby currently uses YARD and a hand-rolled jekyll site for documentation, but I'm thinking about migrating to RDoc.
This would get me a lot for free: search, category browser, table of contents, auto-linking, decent css
Some thoughts:
- Move as much "guides" content into actual source code
- Preserve redirects from old urls
- Transform YARD to RDoc -- is there an automatic transformer? https://github.com/AaronC81/sord ?
- How can I bring-my-own GraphQL syntax highlighting?
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 the existing YARD-generated documentation and hand-rolled Jekyll site, then compare the proposed RDoc workflow and Aliki theme. Define how guides, old-URL redirects, YARD conversion, search, and GraphQL syntax highlighting would be handled; the migration is done when the documentation is served through RDoc without losing those capabilities.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jekyll, ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100