[bencehezso]

Summary

The platform, catalogue, upload and report reference moves out of the README and into the documentation site, so it is authored once instead of being duplicated and drifting. The README keeps its structure and wording and gains a short "Connecting to a platform" section plus a Documentation links table. Adds a changelog and a 1.x → 2.0 migration guide, and cleans up the example configs.

The README goes from 311 to 208 lines. Nothing was added to the README and then removed again; the moved block went straight to the docs site.

Changes

README (311 → 208 lines)

• Removed the reference block, now on the documentation site: Platform settings, Upload modes, Catalogue dataset, Sync document, The report, Reports and uploads and Retries and the spool.
• Added ## Connecting to a platform: the assessment key, CLOUDEXIT_HOST and CLOUDEXIT_API_KEY_FILE, --upload required in CI, and a note that config.py and HOST / KEY are no longer read in 2.0.
• Added ## Documentation, a table pointing at the settings, connected-mode, CI/CD, catalogue, exit-code and troubleshooting pages, the migration guide and the changelog.
• Dropped (alpha) from Data Landscape & Egress Estimation and Infrastructure-as-Code State Scan.
• Quick Start installs from a release tag and pip install ., which gives the cloudexit command, and notes the checkout alternative. python3 is now used consistently, matching AGENTS.md.
• The GitHub Action is marked v1 with a note that a 2.0 version is coming.
• Removed the paragraph offering to generate a regulatory-aligned sample report from an emailed sync.json. It asked users to send their cloud inventory to a contact address from the middle of a configuration section, and it was the same text removed from the CLI's own output.
• License notes that a commercial licence is available through the EscapeCloud enterprise package for organizations that cannot use AGPL-licensed software.
• The embedded report screenshot is replaced by a link to the documentation, which shows an example report.

Repository images

• Removed docs/images/AWS_Config.png, AWS_Profile.png, Azure_CLI.png, Azure_Config.png, Main.png and Report.png, about 4.4 MB. Only Logo.png is kept, which the README header uses.
• Nothing breaks: the documentation site holds its own copies under src/docs/images/ and links to those, not to this repository. The five removed screenshots were unreferenced duplicates, and the report screenshot showed the pre-2.0 HTML design.

New files

• CHANGELOG.md with a 2.0.0 entry: Breaking, Added, Changed, Removed and Deprecated, including that egress estimation and the IaC state scan are no longer alpha, and that the reference moved to the docs site.
• docs/migration-2.0.md, an eight-step guide for 1.x users: a new virtual environment (with the Azure SDK repair command for an in-place upgrade), moving settings off config.py and HOST / KEY, the new exit codes, the Basic report, the new platform keys, payload.json → raw_data/sync.json, and the catalogue replacing the hand-updated datasets/ files.

publiccode.yml

• publiccodeYmlVersion raised from 0.4.0 to 0.8.0, the current standard. All ten required keys are present and the file uses no field deprecated in 0.8.0 (videos, usedBy, dependsOn/open, unsupportedCountries, the government scope, the single-string isBasedOn).
• developmentStatus raised from beta to stable, and softwareVersion: 2.0.0 added.
• Longer description and a fuller feature list covering the inventory, egress estimation, the IaC state scan and offline operation.

Example configs

• config/aws_example.json and config/azure_example.json carried a realistic-looking AWS access key id and real-looking Azure client and tenant GUIDs since the first commit. Replaced with AKIAIOSF•••••••••••• and all-zero GUIDs. The structure is unchanged, so the diffs are two and four lines.

Tests

• tests/test_docs.py holds the documentation to the real CLI: every flag, subcommand and CLOUDEXIT_* variable in the README, changelog and migration guide is checked against the argparse surface; relative links and heading anchors must resolve; no (alpha) may remain; the moved reference block must be absent from the README; and the example configs must hold only placeholders and no secret.

Compatibility

Documentation only. No change to the CLI, its flags, exit codes, the config file format, the dataset, the sync document or the vendored API v2 definition.