Skip to content

About

Documentation tools, Markdown previewer, OpenAPI validator, and changelog generators.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

DeveloperOS Documentation & Specs Suite

Live App

License: MIT Ecosystem: DeveloperOS Tools Directory Privacy: Client--Side CI

Markdown previewers, OpenAPI 3.0 spec visualizers, changelog generators, and README builders.


🚀 Live Application: https://devos-doc-specs.streamlit.app

🖥️ Interface Preview

┌─────────────────────────────────────────────────────────────┐
│ 📚 DeveloperOS Documentation & Specification Suite           │
│ Markdown Live Preview | Table of Contents | OpenAPI Viewer  │
└─────────────────────────────────────────────────────────────┘

🌟 Application Overview & Features

  • Client-Side & Offline-First: All data is processed in-memory. Zero server logging or third-party telemetry.
  • Decoupled Business Logic: Pure algorithm implementations isolated from the user interface.
  • DeveloperOS Design System: Official styling, dark theme, and accessible contrast compliance.
  • Single-Click Exports: Copy outputs directly to clipboard or download formatted artifacts.

🚀 Local Setup & Installation

1. Prerequisites

  • Python 3.12+ (or modern browser/node runtime for web frontends)
  • Standard development tools (git, pip)

2. Quickstart

# Clone the repository
git clone https://github.com/developerOSindia/devos-suite-doc-specs.git
cd devos-suite-doc-specs

# Install dependencies (if applicable)
pip install -r requirements.txt

# Run the local application
streamlit run app.py

🧪 Automated Testing

Run the automated test suite locally:

python3 -m unittest discover -s tests

Continuous integration runs on every push and pull request via GitHub Actions.


🚢 Deployment Guidelines

This project is configured for standalone deployment to: Streamlit Community Cloud (https://docs.toolkit.developeros.in)

For containerized environments, standard Dockerfiles and Compose configurations are supported.


🔒 Security & Privacy

This application processes all user input strictly in-memory with zero persistence:

  • Read our full Security Policy
  • For vulnerability reports, contact: security@developeros.in

🤝 Contributing

Contributions are warmly welcomed! Please read our Contributing Guidelines and check out open issues.


🏷️ Recommended GitHub Topics

When configuring this repository on GitHub, apply these topics: documentation-tools markdown-previewer openapi-viewer changelog-generator streamlit developeros


📜 License & Ecosystem

Distributed under the MIT License. See LICENSE for details.

About

Documentation tools, Markdown previewer, OpenAPI validator, and changelog generators.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages