From 6460b597fad141ff1b3fb792a2c53514ceb07b8b Mon Sep 17 00:00:00 2001
From: Tom Szwaja <59713582+tsxoxo@users.noreply.github.com>
Date: Wed, 18 Oct 2023 09:16:25 +0200
Subject: [PATCH] docs: fix old info in contributing guide (#5779)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

**What's the problem this PR addresses?**
<!-- Describe the rationale of your PR. -->
<!-- Link all issues that it closes. (Closes/Resolves #xxxx.) -->

EDIT: I just saw that #5776 beat me to it. However, the version I
propose adds clarity imho as well as links to relevant resources.

---

The instructions in the 'Writing documentation' section gave false
information (I assume it was simply outdated), making it harder for
people to contribute.

Pls tag for Hacktoberfest.
...

**How did you fix it?**
<!-- A detailed description of your implementation. -->

* Revised the 'Writing documentation' section so that it aligns with our
current project structure
* Fixed broken links
* Provided links to the tech we use
...

**Checklist**
<!--- Don't worry if you miss something, chores are automatically
tested. -->
<!--- This checklist exists to help you remember doing the chores when
you submit a PR. -->
<!--- Put an `x` in all the boxes that apply. -->
- [x] I have read the [Contributing
Guide](https://yarnpkg.com/advanced/contributing).

<!-- See
https://yarnpkg.com/advanced/contributing#preparing-your-pr-to-be-released
for more details. -->
<!-- Check with `yarn version check` and fix with `yarn version check
-i` -->
- [ ] I have set the packages that need to be released for my changes to
be effective.

<!-- The "Testing chores" workflow validates that your PR follows our
guidelines. -->
<!-- If it doesn't pass, click on it to see details as to what your PR
might be missing. -->
- [x] I will check that all automated PR checks pass before the PR gets
reviewed.

Co-authored-by: Maël Nison <nison.mael@gmail.com>
---
 .../docs/advanced/04-technical/contributing.md         | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/packages/docusaurus/docs/advanced/04-technical/contributing.md b/packages/docusaurus/docs/advanced/04-technical/contributing.md
index 3a013c667b56..578aecdcc574 100644
--- a/packages/docusaurus/docs/advanced/04-technical/contributing.md
+++ b/packages/docusaurus/docs/advanced/04-technical/contributing.md
@@ -125,18 +125,20 @@ It's generally seen as [bad form](https://twitter.com/brian_d_vaughn/status/1224
 
 ## Writing documentation
 
-Our website is stored within the [`packages/docusaurus`](https://github.com/yarnpkg/berry/tree/master/packages/docusaurus) directory. *Do not manually edit the html files in the `docs` folder!* Instead, just make your changes in the Gatsby directory (for example you'd edit this very page [here](https://github.com/yarnpkg/berry/blob/master/packages/docusaurus/docs/advanced/04-technical/contributing.md)), then run the following command to spawn a local server and see your changes:
+We use [Docusaurus](https://docusaurus.io/docs) to generate HTML pages from [mdx](https://mdxjs.com/docs/) sources files. 
+
+Our website is stored within the [`packages/docusaurus`](https://github.com/yarnpkg/berry/tree/master/packages/docusaurus) directory. You can change a page by modifying the corresponding `.mdx` file in the `docs` folder. For example, you'd edit this very page [here](https://github.com/yarnpkg/berry/blob/master/packages/docusaurus/docs/advanced/04-technical/contributing.md).
+
+Then run the following command to spawn a local server and see your changes:
 
 ```bash
 yarn start
 ```
 
-Once you're happy with what the documentation looks like, just commit your local changes and open a PR. Netlify will pick up your changes and spawn a fresh preview for everyone to see:
+Once you're happy with what the documentation looks like, just commit your local changes and open a PR. Netlify will pick up your changes and create a fresh preview for everyone to see:
 
 ![](https://user-images.githubusercontent.com/1037931/61949789-3cc09300-afac-11e9-9817-89e97771a4e1.png)
 
-Once everything is green and a maintainer has reviewed your changes, we'll merge them and a bot will automatically trigger a rebuild of the website and update the `docs` folder 🙂
-
 ## Profiling
 
 Run the following command to generate an unminified bundle: