Skip to content

πŸ“ Documentation: Make a docs websiteΒ #1193

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Bug Report Checklist

Overview

I've been mentioning for a while now that I want to have a standalone URL website for this package. Filing this issue as something I can link to & track that with.

I'm not yet sure exactly how I want to make this. There are kind of three options, in increasing order of complexity:

  1. 🍏 Standalone repo: having it be separate from this create-typescript-app repo
    • Advantage: Easiest setup with no need to mess with this repo's tooling
    • Disadvantage: Updates to the website become separate from the repo itself
  2. 🍌 Inline in this repo: adding in some dependencies & scripts to generate a standalone site
    • Advantages: No separation between code and docs
    • Disadvantages: Added overhead of migration snapshots
  3. πŸ’ Converting this repo to a monorepo

I'm leaning towards 🍌 for now. But still pondering.

Additional Info

No response

Metadata

Metadata

Labels

area: documentationImprovements or additions to docsstatus: blockedWaiting for something else to be resolvedtype: featureNew enhancement or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions