LukeParke/documentation-coolify
1
0
Fork 0
mirror of https://github.com/LukeHagar/documentation-coolify.git synced 2025-12-06 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Run dev before editing

Browse Source 
Again, purely personal opinion.
I think first making the environment run before editing is the more natural way.
For example, it reassures the contributor that everything works BEFORE the editing.

If you like the other order more, feel free to drop this commit!
This commit is contained in:
Tim Koch
2024-09-16 17:55:48 +02:00
parent 4ed9f092eb
commit 5761ffcf5b
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@@ -21,11 +21,7 @@ Follow these steps to set up Astro with Starlight and additional extensions:
- [Astro](https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode)
- [MDX](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx)
5. **Create your contribution**
Either edit a markdown file in the `src/content/docs/` directory or create a new `.mdx` file in the `src/content/docs/` directory and start writing your docs article.
6. **Run your Astro site**
5. **Run your Astro site**
Start the development server by running the following command inside the local repository:
```
@@ -33,6 +29,11 @@ Follow these steps to set up Astro with Starlight and additional extensions:
```
This will start a local server and give you a URL to preview your changes.
6. **Create your contribution**
Either edit a markdown file in the `src/content/docs/` directory or create a new `.mdx` file in the `src/content/docs/` directory and start writing your docs article.
7. **Create a Pull Request**
Create a new pull request from your forked repository to the main documentation-coolify repository.