update readme

Author: jannes-io

README.md

@@ -1,36 +1,35 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Forumify Documentation
 
-## Getting Started
+This repository contains the documentation website for [forumify](https://github.com/forumify/forumify-platform)
+as well as first party plugins.
 
-First, run the development server:
+### Running locally
 
+Ensure you have [Node.js](https://nodejs.org/en) >= 22.0 installed.
+
+Use npm to install the required dependencies:
 ```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
+npm install
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
-
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+Then start the development server:
+```bash
+npm run dev
+```
 
-## Learn More
+Open [http://localhost:3000](http://localhost:3000) with your browser and you can see your changes live.
 
-To learn more about Next.js, take a look at the following resources:
+### Managing pages
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+The documentation website uses file based routing, or as NextJS calls it, [App Router](https://nextjs.org/docs/app/getting-started/layouts-and-pages).
+You can find all pages in the `src/app/` directory.
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+A page located at `src/app/user-manual/calendar/page.mdx` would be available at `/user-manual/calendar`.
 
-## Deploy on Vercel
+Pages are written in MDX, which is Markdown + React. This allows for very easy management of pages, while still
+being able to leverage React with complex components sprinkled in.
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+### Contributing
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+Anyone is free to contribute to the documentation website. If you are documenting a new feature for
+which a pull request is still open in the main forumify-platform repository, please mention it in your PR.