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

Folder structure #4

Open
Beanow opened this issue Jun 20, 2019 · 3 comments
Open

Folder structure #4

Beanow opened this issue Jun 20, 2019 · 3 comments
Milestone

Comments

@Beanow
Copy link
Member

Beanow commented Jun 20, 2019

I think we'll create several categories of artefacts here:

  • Research / rationale documents
  • Content for the wizard (context, further reading, options, outputs)
  • Tech and styling of the wizard
  • Builds

They will probably have different processes and even #2 licenses tied to them, so I think it would make sense to create a folder structure to reflect this.

Builds may be better placed elsewhere though. The github pages /docs in master feels a little confusing naming wise. Perhaps a gh-pages branch is a good fit here?

@Beanow Beanow added this to the Scaffolding milestone Jun 20, 2019
@nothingismagick
Copy link
Collaborator

Branch is a pain to maintain, in my opinion. Whats wrong with docs?

@Beanow
Copy link
Member Author

Beanow commented Jun 21, 2019

If you have a CI build connected to a push to master, it would update /docs on master and trigger another push. Infinite build loop 🚀

Naming wise I was thinking something like this, isn't too intuitive.

wizard
├── content
├── docs
├── research
├── src
├── LICENSE
└── README.md

If docs and src could have a better name here I think the top level is reasonably clear.

@Beanow
Copy link
Member Author

Beanow commented Jun 21, 2019

From discord the idea is to use app for the node project instead of src.

wizard
├── app
├── content
├── research
├── LICENSE
└── README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants