Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,62 @@ This document provides pointers for those looking to make documentation changes

- [Documentation Overview](https://github.com/magma/magma/wiki/Contributing-Documentation) for general documentation information
- `make help` for specific commands

## What is Docusaurus?

[Docusaurus](https://docusaurus.io/) is an open-source static site generator built by Meta and powered using React. It’s optimized for creating technical documentation websites for open-source projects, with support for document versioning, ready for translations, content search, and a hot reload feature.

---

## Repository Structure

```text
docusaurus/
├── Dockerfile
├── docker-compose.yml
├── docs/
├── docusaurus.config.js
├── sidebars.js
├── static/
└── src/
```
Comment on lines +20 to +29
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the readmes directory - there is where new documentation is made


---

## How to Setup Docusaurus

1. **Install Docker**
Download and install [Docker Engine](https://docs.docker.com/engine/install/)

For Windows, you must instead install [Docker Desktop](https://apps.microsoft.com/detail/XP8CBJ40XLBWKX?hl=pt-BR&gl=BR&ocid=pdpshare)

3. **Clone the Repository**
Open a terminal in any directory and run:
```bash
git clone https://github.com/magma/magma-documentation.git
```

4. **Start Docusaurus with Docker**
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
```
Comment on lines +47 to +50
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docker already starts by default. Even if not, we assume it does. You can remove this.

Navigate to the project folder:
```bash
cd magma-documentation/docusaurus
```
and set up Docusaurus by:
```bash
docker compose up dev
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

```

5. **Access the Documentation**
Once running, open your browser and visit: [http://localhost:3000/](http://localhost:3000/)

---

## Contact

For further assistance, join our [Slack channel](https://magmacore.slack.com/archives/C01PGTJECGJ)!


Loading