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

improve init package scaffolding baseline starting point #1253

Closed
2 tasks
thescientist13 opened this issue Jun 23, 2024 · 0 comments · Fixed by #1254, #1280 or #1288
Closed
2 tasks

improve init package scaffolding baseline starting point #1253

thescientist13 opened this issue Jun 23, 2024 · 0 comments · Fixed by #1254, #1280 or #1288
Assignees
Labels
alpha.6 enhancement Improve something existing (e.g. no docs, new APIs, etc) Init v0.30.0
Milestone

Comments

@thescientist13
Copy link
Member

thescientist13 commented Jun 23, 2024

Summary

Our current offering as part of the greenwood/init package leaves a bit to be desired, currently dropping user's off with basically nothing. Coming out of a recent team meeting, and with the desire to have a #1247, we should start improving the experience of this workflow, putting it front and center.

So at minimum, we should make it a little more friendly, as this is what we have now, demonstrating a couple basic things like:

  1. A basic custom element with DSD
  2. Ideally no build configuration
  3. Packing as much of everything into a single src/pages/index.html (or an option to get a very vanilla HTML, like the one we have now)
  4. Links to things like our docs, getting started, etc
  5. Respect system preferences for displaying in light / dark mode

Details

This is what it looks like for tools like Next.js, Vite, and Astro respectively for reference.

init-next
init-vite-react
init-astro


Adjacent issues to track:

  1. The getting started should be built to start from this I think, and so the guide should probably be updated accordingly to build from it
    • Markdown / Content as Data
    • Build and Deploy
  2. Additional prompts for the init package
    • Using TypeScript?
    • Using markdown?
@thescientist13 thescientist13 added enhancement Improve something existing (e.g. no docs, new APIs, etc) Init v0.30.0 labels Jun 23, 2024
@thescientist13 thescientist13 added this to the 1.0 milestone Jun 23, 2024
@thescientist13 thescientist13 self-assigned this Jun 23, 2024
@thescientist13 thescientist13 added website Tasks related to the projects website / documentation RFC Proposal and changes to workflows, architecture, APIs, etc labels Jun 23, 2024
@thescientist13 thescientist13 changed the title improve init package baseline starting point improve init package DX baseline starting point Jun 24, 2024
@thescientist13 thescientist13 mentioned this issue Jun 26, 2024
39 tasks
@thescientist13 thescientist13 linked a pull request Jun 27, 2024 that will close this issue
13 tasks
@thescientist13 thescientist13 changed the title improve init package DX baseline starting point improve init package scaffolding baseline starting point Jul 7, 2024
@thescientist13 thescientist13 moved this from 🏗 In progress to 👀 In review in [Greenwood] Phase 9 - Standards and Conventions Aug 3, 2024
@thescientist13 thescientist13 removed RFC Proposal and changes to workflows, architecture, APIs, etc website Tasks related to the projects website / documentation labels Aug 29, 2024
@thescientist13 thescientist13 added feature New feature or request enhancement Improve something existing (e.g. no docs, new APIs, etc) and removed enhancement Improve something existing (e.g. no docs, new APIs, etc) feature New feature or request labels Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment