feat: added instructions on how to setup Docusaurus to README.md #43
Conversation
This file contains hidden or 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
Updated README.md with: information on what is docusaurus repository structure steps on how to setup docusaurus for windows and other OS mentioned the hot reload feature for development added links to slack
lucaaamaral
requested changes
Aug 28, 2025
Comment on lines
+47
to
+50
| You can now start Docker by opening it if you chose to install Docker Desktop or, for Docker Engine, with: | ||
| ```bash | ||
| sudo systemctl start docker | ||
| ``` |
There was a problem hiding this comment.
Docker already starts by default. Even if not, we assume it does. You can remove this.
| ``` | ||
| and set up Docusaurus by: | ||
| ```bash | ||
| docker compose up dev |
There was a problem hiding this comment.
docker compose up -d dev - recommend using the -d to run as daemon.
Mention docker compose down or docker stop container to stop the execution of docusaurus.
Comment on lines
+20
to
+29
| ```text | ||
| docusaurus/ | ||
| ├── Dockerfile | ||
| ├── docker-compose.yml | ||
| ├── docs/ | ||
| ├── docusaurus.config.js | ||
| ├── sidebars.js | ||
| ├── static/ | ||
| └── src/ | ||
| ``` |
There was a problem hiding this comment.
Add the readmes directory - there is where new documentation is made
|
Superseded by #43 |
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.
Updated README.md with:
information on what is docusaurus
repository structure
steps on how to setup docusaurus for windows and other OS mentioned the hot reload feature for development
added links to slack
Summary
Test Plan
Additional Information
Security Considerations