Logo

General

  • Contributing to Read the Docs
  • Code of Conduct
  • Overview of issue labels
  • Roadmap
  • Design documents
    • API v3 design document
    • Better handling of docs URLs
    • Build images
    • Embed APIv3
    • Version file tree diff
    • Future builder
    • In-doc search UI
    • Notification system: a new approach after lot of discussions
    • New search API
    • Proposed contents for new Sphinx guides
    • Organizations
    • Design of pull request builder
    • Privacy levels
    • Improving redirects
    • Refactor RemoteRepository object
    • Secure API access from builders
    • sphinxcontrib-jquery
    • Allow installation of system packages
    • Collect data about builds
    • Read the Docs data passed to Sphinx build context
    • YAML configuration file

Development

  • Development installation
  • Development guides
  • Designing Read the Docs
  • Building and contributing to documentation
  • Documentation style guide
  • Front-end development
  • Internationalization
  • Database migrations
  • Server side search
  • Server side search integration
  • Subscriptions
  • GitHub App
  • Interesting settings
  • Testing
Read the Docs developer documentation
  • Design documents
  • Edit on GitHub

Design documents

This is where we outline the design of major parts of our project. Generally this is only available for features that have been build in the recent past, but we hope to write more of them over time.

Warning

These documents may not match the final implementation, or may be out of date.

  • API v3 design document
  • Better handling of docs URLs
  • Build images
  • Embed APIv3
  • Version file tree diff
  • Future builder
  • In-doc search UI
  • Notification system: a new approach after lot of discussions
  • New search API
  • Proposed contents for new Sphinx guides
  • Organizations
  • Design of pull request builder
  • Privacy levels
  • Improving redirects
  • Refactor RemoteRepository object
  • Secure API access from builders
  • sphinxcontrib-jquery
  • Allow installation of system packages
  • Collect data about builds
  • Read the Docs data passed to Sphinx build context
  • YAML configuration file
Previous Next

© Copyright Read the Docs, Inc & contributors.

Built with Sphinx using a theme provided by Read the Docs.