Skip to content

Migrate to RDoc #5576

@rmosolgo

Description

@rmosolgo

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions