Update DISCO documentation #614
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JulienVig
commented
Jan 30, 2024
…requirements from @typescript-eslint/eslint-plugin
…06-update-doc-julien
|
Read to merge this PR, I will update the remaining docs after other PRs which are susceptible to change the doc content are merged. |
tharvik
reviewed
Feb 7, 2024
EduardDurech
previously approved these changes
Feb 9, 2024
Co-authored-by: Valérian Rousset <[email protected]>
Co-authored-by: Valérian Rousset <[email protected]>
tharvik
approved these changes
Feb 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The DISCO documentation has become outdated over time and the recent refactor. I also improve the instructions from a newcomer's point of view and included information from the onboarding video as well as what I had to figure out by myself. Notably, I created an installation script
install.shto install and build the different project modules.To review:
README.mdDEV.mddocs/ONBOARDING.mddocs/CONTRIBUTING.mddocs/DISCOJS.mddocs/ARCHITECTURE.mddocs/PRIVACY.mdweb-client/src/components/README.mddocs/VUEJS.mddocs/TASK.md- Did most of it, will come back to it when I need to implement a custom task
docs/FAQ.mdWill address the following after other PRs are merged (fixing the CLI, integrating npm workspaces or Buns) as they may affect the doc instructions
docs/node_exampleweb-client/README.mdserver/README.mdcli/README.mddiscojs/README.mddiscojs/discojs-core/README.mddiscojs/discojs-node/README.mddiscojs/discojs-web/README.mdCloses #549, Closes #606