[README] Improve documentation (2026-02-23)

README.md

@@ -1,36 +1,131 @@
-# Website
+# DreamFactory Documentation
 
-This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
+Official documentation for [DreamFactory Platform](https://www.dreamfactory.com/) — an open-source REST API platform that auto-generates, secures, and manages APIs for any database, file storage, or external service.
 
-### Installation
+**📖 Read the docs:** [https://docs.dreamfactory.com](https://docs.dreamfactory.com)
+**💻 Contribute:** See [Contributing](#contributing-to-the-documentation) below
+**🐛 Report issues:** [GitHub Issues](https://github.com/dreamfactorysoftware/df-docs/issues)
 
-```
-$ npm install
-```
+---
+
+## About This Documentation
+
+This repository contains the source code for the official DreamFactory documentation site, built using [Docusaurus 3](https://docusaurus.io/). The documentation covers:
+
+- **API Reference** — Auto-generated API endpoints, request/response formats, and authentication
+- **Integration Guides** — Step-by-step guides for connecting databases, file systems, and third-party services
+- **Deployment & Hosting** — Self-hosted, Docker, and cloud deployment options
+- **Administration** — User management, roles, security, and configuration
+
+**Audience:** Developers integrating DreamFactory, API consumers, and DevOps engineers managing DreamFactory instances.
+
+---
+
+## Using the Documentation
+
+The live documentation is available at: **[https://docs.dreamfactory.com](https://docs.dreamfactory.com)**
 
-### Local Development
+> **No need to build locally** — just visit the link above to read the docs.
+>
+> Only follow the steps below if you are contributing to or developing the documentation site itself.
+
+---
+
+## Documentation Structure
 
 ```
-$ npm run start
+df-docs/
+├── docs/
+│   ├── api/          — API reference documentation
+│   ├── guides/       — Step-by-step integration guides
+│   └── deployment/   — Deployment and hosting guides
+├── sidebars.js       — Sidebar navigation configuration
+├── docusaurus.config.js — Site configuration
+└── static/           — Static assets (images, files)
 ```
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+---
+
+## Contributing to the Documentation
+
+We welcome contributions! Whether you're fixing a typo, improving an explanation, or adding a new guide, here's how to get started:
+
+1. **Fork** this repository
+2. **Create a feature branch:**
+   ```bash
+   git checkout -b docs/add-my-section
+   ```
+3. **Make your changes** — see [Installation](#installation) and [Local Development](#local-development) below to preview them
+4. **Commit your changes:**
+   ```bash
+   git commit -m "docs: add guide for X integration"
+   ```
+5. **Open a Pull Request** against the `main` branch
 
-### Build
+For larger changes, please [open an issue](https://github.com/dreamfactorysoftware/df-docs/issues) first to discuss your proposal.
 
+---
+
+## Installation
+
+Clone the repository and install dependencies:
+
+```bash
+git clone https://github.com/dreamfactorysoftware/df-docs.git
+cd df-docs
+npm install
 ```
-$ npm run build
+
+> **Prerequisites:** [Node.js](https://nodejs.org/) >= 18 and npm are required.
+
+---
+
+## Local Development
+
+Start a local development server with live reload:
+
+```bash
+npm run start
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+This command starts a local development server and opens a browser window at `http://localhost:3000`. Most changes are reflected live without having to restart the server.
+
+---
 
-### Deployment
+## Build
 
+Generate a production-ready static build:
+
+```bash
+npm run build
 ```
-$ npm run serve
+
+This command generates static content into the `build/` directory, which can be served by any static hosting service. To preview the production build locally:
+
+```bash
+npm run serve
 ```
 
-$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
+---
+
+## Deployment
+
+### GitHub Pages
+
+If you are hosting on GitHub Pages, deploy with:
+
+```bash
+GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
 ```
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+This builds the site and pushes it to the `gh-pages` branch automatically.
+
+### Other Hosting
+
+The contents of the `build/` directory after running `npm run build` can be deployed to any static hosting provider (Netlify, Vercel, AWS S3, etc.).
+
+---
+
+## License
+
+This documentation is licensed under the [MIT License](LICENSE). See the `LICENSE` file for details.