Skip to content

Simplify README and link to rustdoc from website #8

@dannywillems

Description

@dannywillems

Description

  1. Remove Quick Start section from README - redirect to website/rustdoc
  2. Link rustdoc from Docusaurus website

README Changes

Docusaurus Changes

  • Add link to rustdoc in navbar
  • Add "API Reference" section linking to docs.rs
  • Schema/queries page should link to rustdoc examples

Benefits

  • Single source of truth for code examples
  • Less maintenance burden
  • Examples always up-to-date (rustdoc compiles them)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions