PlaidWeb / PlaidWeb/Chorus

Official website

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

Nobody has claimed this yet.

Dominant language
No language data
Stars
22
Forks
0
PR merge metrics
No merged PRs in 30d

Description

There needs to be an official website that is a bit more user-facing than this GitHub repository. Ideally this would be published statically somewhere.

One of the recurring jokes in the examples has been a fake record label called MecaGorp (a spoonerism on "MegaCorp") and to that end I've registered mecagorp.com, which could be a good domain name for both Chorus and some of its related things (e.g. some aggregator/player frontends), and it's worth investigating if there's any good systems that would let us draw from this git repository to do a nice version selector thingy like what some other documentation sites do (e.g. readthedocs.io, python.org, etc.)

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 repository's examples and the user-facing needs described in this issue, then compare static publishing and documentation systems such as Read the Docs and python.org. Investigate whether mecagorp.com is suitable and how a version selector could draw from this repository. Done means an agreed website scope, publishing approach, and versioning plan.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.