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

Bundling instructions #5

Open
jorgeorpinel opened this issue Jun 15, 2021 · 2 comments
Open

Bundling instructions #5

jorgeorpinel opened this issue Jun 15, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@jorgeorpinel
Copy link
Contributor

The REAMDE here seems to be the same as in the generated repo. Should it include bundling instructions instead?

Cc @rogermparent

@jorgeorpinel jorgeorpinel added the documentation Improvements or additions to documentation label Jun 15, 2021
@jorgeorpinel jorgeorpinel changed the title bundling instructions Bundling instructions Jun 15, 2021
@jorgeorpinel jorgeorpinel added the question Further information is requested label Jun 15, 2021
@rogermparent
Copy link
Contributor

Currently, the parent repo intentionally copies its README to the dist repo, keeping the two only lightly coupled so any commit of the parent repo is capable of generating its intended output- README and all.

It could be worth differentiating the two, but we should note that the README on the dist repo will be the one shown on the GitHub marketplace. We could treat this parent repo's README as a separate dev-only README, or alternatively keep copying the README and use a CONTRIBUTING.md in this parent repo.

@rogermparent
Copy link
Contributor

rogermparent commented Jun 15, 2021

There are also currently deployment docs, they're just at the bottom of the README.

The repo builds into two apps: one usable on the CLI and one that's deployed as a GitHub action (the submodule). This could've been done a lot better in hindsight, but I still don't have the chance to work on it. Let me know if the docs aren't sufficient and I can help fill in the gaps!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants