📚 Praman Network Documentation Website

Welcome! This is the official documentation website for the Praman Network. It is built using Docusaurus.

If you are here to help improve, edit, or add to our documentation, you are in the right place! This guide will show you exactly how to run this documentation site on your computer so you can preview your changes locally before submitting them.

---

🛠️ Prerequisites

Before you start, make sure you have the following installed on your computer:

1. Node.js (Version 20 or higher) - Download here
2. npm (Node Package Manager) - This comes pre-installed when you install Node.js.

---

🚀 How to Run the Docs Locally

Follow these simple steps to run the documentation website on your machine.

Step 1: Open your terminal and clone the repository

Open your terminal (Command Prompt/PowerShell on Windows, or Terminal on Mac/Linux) and clone this repository:

git clone https://github.com/Praman-Network/docsPramanNetwork.git
cd docsPramanNetwork

Step 2: Install dependencies

Run this command to download all the necessary packages:

npm install

Step 3: Start the documentation website!

Once the installation is complete, start the local server:

npm run start

Step 4: View the website 🎉

The website should automatically open in your browser. If it doesn't, open your browser and go to: 👉 http://localhost:3000

Now, any changes you make to the files will automatically update on the website immediately! You don't need to restart the server.

---

📁 How to Make Changes?

If you want to edit the documentation or add new pages, here is where you do it:

• docs/ Folder: This is the most important folder! All the documentation pages live here as Markdown files (.md).
  • Editing a page: Just open any .md file and start typing.
  • Adding a new page: Create a new .md file inside this folder.
• src/pages/index.tsx: This is the custom homepage of the website.
• docusaurus.config.ts: The main settings file. You can change the website title, navbar links, and footer here.

---

💡 Quick Tips for Contributors

• Markdown (.md): Documentation is written in Markdown. It's a very simple way to format text. Learn Markdown here.
• Sidebar Ordering: You can control the order of the pages in the left sidebar by adding sidebar_position: 1 at the very top of your .md files.
• Stopping the server: When you are done working, go back to your terminal and press Ctrl + C to stop the website.

Happy documenting! 📝✨