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.

Sign up for GitHub

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

Jump to bottom

Initial project documentation #31

Closed
svengreb opened this issue Nov 9, 2020 · 0 comments · Fixed by #32
Closed

Initial project documentation #31

svengreb opened this issue Nov 9, 2020 · 0 comments · Fixed by #32
Labels
context-documentation context-techstack scope-maintainability scope-quality scope-ux type-feature
Milestone
0.5.0

Comments

@svengreb
Copy link
Owner

svengreb commented Nov 9, 2020 •
edited
Loading

Write the initial project documentation for the README.md file that includes…

  1. …an project introduction and motivation.
  2. …an overview of the project features.
  3. …an overview of the directory structure.
  4. …more detailed sections about all features.
  5. …some basic instructions how to use this template repository.
  6. …information about references used for this template repository.
  7. …information about how to contribute to this project.

Each directory documented in step 3 will contain an individual documentation with more detailed information about it.
The package.json file will be extended to included the Yarn/NPM workspaces field.
@svengreb svengreb added this to the Next milestone Nov 9, 2020
@svengreb svengreb self-assigned this Nov 9, 2020
svengreb added a commit that referenced this issue Nov 9, 2020
@svengreb
Initial project documentation
cb4ef1d 
Wrote the initial project documentation for the `README.md` file that
includes...

1. ...an project introduction and motivation.
2. ...an overview of the project features.
3. ...an overview of the directory structure.
4. ...more detailed sections about all features.
5. ...some basic instructions how to use this template repository.
6. ...information about references used for this template repository.
7. ...information about how to contribute to this project.

Each directory documented in step 3 contains an individual documentation
with more detailed information about it.
The `package.json` file has been extended to include the
Yarn [1] / NPM [2] `workspaces` field.

[1]: https://classic.yarnpkg.com/docs/workspaces
[2]: https://docs.npmjs.com/cli/v7/using-npm/workspaces

GH-31
@svengreb svengreb mentioned this issue Nov 9, 2020
Merged
svengreb added a commit that referenced this issue Nov 9, 2020
@svengreb
Initial project documentation (#32)
d1a77a3 
Wrote the initial project documentation for the `README.md` file that
includes...

1. ...an project introduction and motivation.
2. ...an overview of the project features.
3. ...an overview of the directory structure.
4. ...more detailed sections about all features.
5. ...some basic instructions how to use this template repository.
6. ...information about references used for this template repository.
7. ...information about how to contribute to this project.

Each directory documented in step 3 contains an individual documentation
with more detailed information about it.
The `package.json` file has been extended to include the
Yarn [1] / NPM [2] `workspaces` field.

[1]: https://classic.yarnpkg.com/docs/workspaces
[2]: https://docs.npmjs.com/cli/v7/using-npm/workspaces

Closes GH-31
@svengreb svengreb removed their assignment Nov 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
context-documentation context-techstack scope-maintainability scope-quality scope-ux type-feature
Projects
None yet
Milestone
0.5.0
Development

Successfully merging a pull request may close this issue.

Initial project documentation svengreb/tmpl-go
1 participant
@svengreb