Skip to content
This repository has been archived by the owner on Sep 7, 2020. It is now read-only.

Add more detailed documentation explaining commands #26

Closed
wants to merge 1 commit into from

Conversation

Markus-Ende
Copy link
Collaborator

No description provided.

@Markus-Ende
Copy link
Collaborator Author

Ah, I just saw that @Strulle already adds a jest description in #25. I'll remove it here.

@Markus-Ende
Copy link
Collaborator Author

Should we add some more detailed info in sub-sections of README?

@GregOnNet
Copy link
Member

Yes, we definitely should add a more detailed description for each command and its arguments.

First, we could document every command in README.md.

@GregOnNet GregOnNet changed the title Added descriptions to readme Add more detailed documentation explaining commands Mar 31, 2019
@FrankStrieter
Copy link
Member

I recognized, that I missed changing the root´s README of the repo. Instead, I only updated the README of /packages/schematics/. Maybe we can also use this PR to fix this.

@GregOnNet
Copy link
Member

GregOnNet commented Apr 1, 2019

I suggest using the root README to just link to the child packages.
We can add a table to the README.

Package Description
@co-it/schematics Schematics helping to build projects scaling better.

@Markus-Ende Markus-Ende mentioned this pull request Apr 2, 2019
4 tasks
@GregOnNet
Copy link
Member

Markus and I talked about this PR.
We decide to close this PR in favour of another documentation PR.

@GregOnNet GregOnNet closed this Apr 25, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants