Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Documentation: Make & link to a docs website #1193

Open
2 tasks done
JoshuaKGoldberg opened this issue Jan 5, 2024 · 1 comment
Open
2 tasks done

📝 Documentation: Make & link to a docs website #1193

JoshuaKGoldberg opened this issue Jan 5, 2024 · 1 comment
Assignees
Labels
area: documentation Improvements or additions to docs status: blocked Waiting for something else to be resolved type: feature New enhancement or request

Comments

@JoshuaKGoldberg
Copy link
Owner

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

@JoshuaKGoldberg JoshuaKGoldberg added area: documentation Improvements or additions to docs type: feature New enhancement or request status: in discussion Not yet ready for implementation or a pull request labels Jan 5, 2024
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Jan 5, 2024
@JoshuaKGoldberg
Copy link
Owner Author

Blocked on the create package in #1181.

@JoshuaKGoldberg JoshuaKGoldberg added status: blocked Waiting for something else to be resolved and removed status: in discussion Not yet ready for implementation or a pull request labels Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Improvements or additions to docs status: blocked Waiting for something else to be resolved type: feature New enhancement or request
Projects
None yet
Development

No branches or pull requests

1 participant