readthedocs / readthedocs/website

Content: "Labs" page

Open
#136 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Needed: design decision
Dominant language
HTML
Stars
21
Forks
11
Avg merge
3d 18h
Merged PRs (30d)
8

Description

A fun way to collect some of the farther out use cases for Read the Docs, and some of our more proof of concept work, would be to have an enumeration of some of these in a "Labs" page. This would be a listing of some of our skunkworks projects, to highlight some of the farther reaches of what is possible with Read the Docs.

This would have a marketing focus above all, but would also be a place to promote some of the fun things we try out.

A few other "labs" examples:

I think a labs page would be best off with just a bit more narrative though. Some of the examples above are just indexes of pages, which isn't super compelling. We could do more to link to GitHub repos, provide a richer description of each project -- images, etc -- and eventually a subpage/example project/something explicitly usable to users.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Read the Docs website structure and the example Labs pages linked in the issue. Define a Labs page with narrative descriptions, project links, images, and room for future subpages or example projects. Done means the marketing-focused page clearly presents the selected proof-of-concept work and explains what users can explore.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
content
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.