🖥️
Brandon Mitchell's Hub
  • Overview
  • 👽Personal Life
    • 🏋️Diet + Fitness
    • 📅Daily Routine
    • ♟️Chess
  • 💰Finance
    • 💱Budgeting
    • 💸Portfolio Breakdown
    • 📈Strategies
    • 📓Notes
      • Helpful Financial Resources
      • Understanding Income
  • 💻Software Engineering
    • How-Tos
    • Data Structures + Algs
    • Design Patterns
      • The Observer Pattern
      • The Decorator Pattern
      • The Factory Pattern
      • The Singleton Pattern
      • The Command Pattern
      • The Adapter & Facade Pattern
      • The Template Method Pattern
      • The Iterator & Composite Patterns
      • Compound Patterns
      • The State Pattern
      • The Proxy Pattern
    • Reverse Engineering
  • 📚Portfolio
    • 📖Public Repos
    • 📕Private Repos
  • 🧙‍♂️Resources
    • 🔁Interview Prep
    • 📺Youtube Channels
    • 🔖Reading List
  • ✍️Blog
    • Software Engineering
      • Career
        • Being a Leader as an IC
        • What I've learned from creating software companies
      • Code Katas
        • Intro to Code Katas
        • Code Kata #1: Supermarket Pricing
      • General
        • Cryptography
          • What is Cryptography?
          • Symmetric Key Cryptography
          • Asymmetric Key Cryptography
          • Encryption Algorithms
          • Digital Signatures
          • Key Management
          • SSL / TLS
          • JSON Web Tokens (JWT)
      • Reverse Engineering
        • Secure Coding Practices in Preventing Web App Vulnerabilities
      • Tech Review Fridays
        • 3/24/2023 - MongoDB
        • 3/17/2023 - ntfy.sh
        • 3/10/2023 - swimm
        • 3/3/2023 - Caido
        • 2/24/2023 - Charles
        • 2/17/2023 - Hop.io
        • 2/10/2023 - CommitGPT
        • 2/3/2023 - VSCode Extensions
        • 1/27/2023 - Notion
        • 1/20/2023 - Script Kit
        • 1/13/2023 - ChatGPT
    • Finance
      • Retirement
      • Budgeting
      • Investing
Powered by GitBook
On this page
  • Overview
  • Pros
  • Cons
  • Reference:
  1. Blog
  2. Software Engineering
  3. Tech Review Fridays

3/10/2023 - swimm

Automated and local code documentation

Previous3/17/2023 - ntfy.shNext3/3/2023 - Caido

Last updated 2 years ago

Overview

Tired of boring README.md files? Tired of writing on confluence (a site I despise wriiting docs on)? Want to have your docs integrated with real code examples, without navigating through multiple windows? Then Swimm is your answer! This tool is built for developers to transfer knowledge and outline documentation much faster and much cleaner. Integrate docs directly within repositories, import from existing readme's, and a ton more.

Pros

  • Support for various git hosts

  • Beautiful UI

  • Support for various IDEs (VSCode etc)

Cons

  • Pricing is meh, freemium model and free version limits to one repository

  • Editing docs has to be in their text editor first

Reference:

  • https://swimm.io/

Dark mode

✍️
🎉