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

Update module installation doc #635

Closed
6 of 12 tasks
JulienVig opened this issue Feb 22, 2024 · 2 comments · Fixed by #636
Closed
6 of 12 tasks

Update module installation doc #635

JulienVig opened this issue Feb 22, 2024 · 2 comments · Fixed by #636
Assignees
@JulienVig
Labels
documentation Improvements or additions to documentation rework Code that needs to be improved
Milestone
v3.0.0

Comments

@JulienVig
Copy link
Collaborator

JulienVig commented Feb 22, 2024 •
edited
Loading

The installation instructions are currently outdated, especially now that we are using npm workspaces.
Update how to install and how to use each module of disco.

  • misformatted markdown at the top of DEV.md
  • outdated testing instructions in docs/ONBOARDING.md
  • outdated VSCode import tip in docs/ONBOARDING.md
  • docs/node_example
  • web-client/README.md
  • server/README.md
  • cli/README.md
  • discojs/README.md
  • discojs/discojs-core/README.md
  • discojs/discojs-node/README.md
  • discojs/discojs-web/README.md
  • Merge server, web-client, discojs installation and usage in DEV.md
@JulienVig JulienVig added documentation Improvements or additions to documentation rework Code that needs to be improved labels Feb 22, 2024
@JulienVig JulienVig self-assigned this Feb 22, 2024
@tharvik
Copy link
Collaborator

tharvik commented Feb 22, 2024

arf, I though I updated the doc with the workspaces' PR but indeed, seems like I missed quite a few places, oupsi

@JulienVig
Copy link
Collaborator Author

Fixes #609, mostly done after the workspace refactoring.

@JulienVig JulienVig mentioned this issue Feb 22, 2024
Merged
@JulienVig JulienVig linked a pull request Feb 22, 2024 that will close this issue
Update doc according npm workspace #636
Merged
@martinjaggi martinjaggi added this to the v3.0.0 milestone Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JulienVig JulienVig

Labels
documentation Improvements or additions to documentation rework Code that needs to be improved
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging a pull request may close this issue.

Update doc according npm workspace epfml/disco
3 participants
@martinjaggi @tharvik @JulienVig