Skip to content

docs: migrate README content to the Read the Docs site #112

Description

@shejnowicz

Follow-up to #110 (scaffold). Move the remaining README sections into docs/ pages and shrink the README to a landing page:

  • Getting started: full install options (Docker image / installer / git clone), devcontainer flow, IDE specifics (VS Code, JetBrains)
  • Configuration: settings format & layers, applying changes, secret substitution (op://, pass://, plain values), extra_hosts, upstream CA bundles
  • CLI reference: fold in cli/README.md (init/run/compose/edit/cache/restart/destroy/proxy/attach/version)
  • Security: hardening VS Code, volume split (security: sharing ~/.mitmproxy to app #25), no-new-privileges/sudo removal, strict-network once feat(cli): --features strict-network — stack presets instead of the wildcard #106 lands
  • Operations: testing the proxy, debugging, unit tests
  • Project: inspiration, development, commercial support

Rules of thumb: pages lifted verbatim where possible (heading levels normalized), internal anchors updated as sections move, README ends as a short landing page linking to the site.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions