Merge pull request #134 from niccokunzmann/docs-docs

Add documentation.md file

Author: dansup

.vitepress/config.mjs

@@ -32,6 +32,7 @@ export default defineConfig({
         items: [
           { text: 'Introduction', link: '/project/introduction' },
           { text: 'Community', link: '/project/community' },
+          { text: 'Documentation', link: '/project/documentation' },
         ]
       },
       {

project/documentation.md

@@ -0,0 +1,64 @@
+# Documentation
+
+The Pixelfed documentation can be found at [docs.pixelfed.org].
+The source code repository for the documentation is hosted on GitHub at [pixelfed/docs].
+If you find any mistakes in the documentation, please have a look at the [open issues](https://github.com/pixelfed/pixelfed-docs) and open a new one if yours does not exist.
+
+## Contributing to Documentation
+
+The following sections should get you started on contributing to the documentation of Pixelfed.
+Before getting started, please read the [Code of Conduct].
+
+## Writing Documentation Online
+
+To get started writing the documentation, you only need a GitHub account.
+You can find the documentation in its [GitHub repository][pixelfed/docs].
+Find the right page and after log-in, you can see an edit button above the document.
+Please create a Pull Request with your changes.
+We are using [Markdown] as the format for the documentation files (`.md`).
+
+[Markdown]: https://www.markdownguide.org/cheat-sheet/
+
+## Building the Documentation Locally
+
+For most additions and changes to the documentation, you do not need to build the documentation locally.
+
+If you choose to build the documentation website on your own computer, follow these steps:
+
+1. Clone the [pixelfed/docs] repository.
+
+    ```sh
+    git clone https://github.com/pixelfed/docs.git pixelfed-docs
+    cd pixelfed-docs
+    ```
+
+2. Install [node and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
+3. Install [VitePress] and the other dependencies.
+
+    ```sh
+    # in the pixelfed-docs directory
+    npm install
+    ```
+
+4. Build and serve the documentation:
+
+    ```sh
+    npm run docs:dev
+    ```
+
+    Then, visit [localhost:5173](http://localhost:5173/) in your browser.
+    It should look like [docs.pixelfed.org].
+    Now, whenever you change a file, it should automatically reload with the changes.
+
+## Related Links
+
+- [Markdown]
+- [VitePress]
+- [Code of Conduct]
+- [The official documentation][docs.pixelfed.org]
+- [The documenation repository][pixelfed/docs]
+
+[VitePress]: https://vitepress.dev/
+[docs.pixelfed.org]: https://docs.pixelfed.org
+[Code of Conduct]: https://github.com/pixelfed/docs/blob/main/CODE_OF_CONDUCT.md
+[pixelfed/docs]: https://github.com/pixelfed/docs