Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.25 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.25 KB

Open PaaS Platform Docs

This is a sample documentation repository for a Platform-as-a-Service (PaaS) product simulator. It is designed to give developers an example of how to integrate with a PaaS platform by building applications on top of it.

Access Documentation

The documentation is deployed and available online. You can access it @ Open PaaS Platform Documentation

Key Sections

  • Introduction: Overview of the platform.
  • Getting Started: A quick start tutorial to help basic users begin with the platform.
  • Golden Use Cases: In-depth technical guides for advanced users, such as integrating third-party APIs.

How to Build Locally

To build and view the documentation locally, follow these steps:

  1. Clone the repository:

  2. Install dependencies:

    pip install mkdocs mkdocs-material

  3. Serve the documentation locally: To preview the docs locally, run:

    mkdocs serve

  4. Build the site: To generate the static site files, run:

    mkdocs build

    The files will be saved in the site/ directory.

Contributions

This repository is for demonstration purposes only. There are no active contributions required.