Diagram As Text

The tool to generate diagram based on textual description.

🚀🚀🚀 Mission: to enable anyone to explain complex system, or process in a simple way.

🚀🚀 Objective: to streamline knowledge sharing through diagrams.

🚀 MVP: plain english to C4 container diagrams.

The work is driven by the motivation to streamline knowledge sharing by enabling effective generation of visual materials. We aim to take a step beyond the "diagram as code" approach and remove the additional step between the idea of what shall be displayed and the illustration.

We all know that “a picture is worth a thousand words”. Although it takes quite some effort to make a diagram, LLM is here for the rescue! All one needs is, a description in plain English to get desired result in no time! 🤖🦾

Outlook

• Contacts
• Bets/Panning/Commitment
• Contribution
  • Ways of work
    • Manifesto
    • Process
    • Tech stack
• License
  • Codebase
  • Images and diagrams

Contacts

• hi@diagramastext.com
• LinkedIn

Bets/Panning/Commitment

• Issues Board

Contribution

🔔 Wanted: founding contributors 🔔

Ways of work

Manifesto

• We are driven by the mission
• We respect one another and the community
• We deliver in lean iterations
• We work async with pairing programming sessions
• We share the work openly, see the license details

Process

• We follow TDD
• We follow RDD
• We maintain flat modules structure whether possible
• We aim for simplicity with the least external dependencies
• We follow the release guideline and semantic versioning
• We follow conventional commits guideline:
  • feat: for features
  • fix: for defect fix
  • chore: for infra, ci, or docs adjustments; or refactoring
• We follow conventional comments guideline for code reviews
• We follow the monorepo approach

Tech stack

• Languages:
  • Go 1.19
  • Vanilla javascript
  • Python 3.9
• Markup:
  • Markdown
  • HTML5
  • CSS3
• CI:
  • GitHub Actions
• Infra:
  • AWS:
    • IAM
    • Lambda
    • API Gateway
  • GitHub Pages
  • Neon
  • Temp: bare server hosted on netcup
  • Cloudflare
  • namecheap
  • godaddy
• Tools:
  • gnuMake
  • Docker
  • terraform
  • slack
• Logic:
  • PlantUML
  • OpenAI

License

Codebase

The codebase is distributed under the Apache 2.0 licence.

Images and diagrams

This work by diagramastext.dev is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. Based on a work at https://github.com/kislerdm/diagramastext. Permissions beyond the scope of this license may be available at diagramastext.dev.