Skip to content

docs: README couvre SPA, convertisseur et CI#43

Merged
BartM82 merged 2 commits into
mainfrom
docs/readme-update
May 15, 2026
Merged

docs: README couvre SPA, convertisseur et CI#43
BartM82 merged 2 commits into
mainfrom
docs/readme-update

Conversation

@sebdraven
Copy link
Copy Markdown
Member

@sebdraven sebdraven commented May 15, 2026

Summary

Reecrit le README pour couvrir l'ensemble du travail recent (PR #38, #39, #40, #41).

Contenu

  • DIMA Navigator : lien GitHub Pages, fonctionnalites (recherche, panneau detail, export PDF matrice), instructions pour servir en local.
  • Rapport de campagne : workflow analyste de bout en bout — selection a la case (technique + tactique avec etat mixte), persistance localStorage, export PDF / JSON, reimport.
  • Convertisseur Python : usage uv run pour md2json, json2md, md2misp, format JSON, contrat MISP galaxy.
  • Convention markdown : separateurs, liens [source](url), sous-sections **Titre:**, pas de doublons d'IDs.
  • Tests : commande pytest via uv.
  • CI / CD : tableau resumant les 4 workflows (tests, pages, misp, release).
  • Layout du repo : arborescence des dossiers.

Note

Le README documente l'etat cible une fois toutes les PR mergees (#40 / #41 / #42 sont encore ouvertes au moment d'ecrire ce PR). Merger ce PR en dernier garantit que le README colle a la realite.

Generated with Claude Code

Expands the historical two-paragraph README into a navigable document
that covers every piece added during the recent series of PRs:

- DIMA Navigator (GitHub Pages SPA) with search, detail panel, PDF
  export and how to run it locally.
- Campaign report workflow: selection (per-technique and per-tactic
  bulk toggle), localStorage persistence, PDF and JSON export, JSON
  re-import.
- Python converter (md2json, json2md, md2misp) with usage examples,
  produced JSON schema and the MISP galaxy contract.
- Markdown convention enforced across the four phase files.
- pytest entry point and the three Actions workflows (tests, pages,
  misp sync-check) plus the existing release workflow.
- A repo-layout map for newcomers.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@sebdraven sebdraven changed the title docs: README couvre SPA, convertisseur, MISP et CI docs: README couvre SPA, convertisseur et CI May 15, 2026
PR #42 is still in review. Removes from the README the quick-start row,
the dedicated MISP section, the md2misp command sample, the misp.yml CI
row and the misp/ entry in the repo layout. They will be added back in
a follow-up commit once #42 is merged.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@sebdraven sebdraven requested a review from BartM82 May 15, 2026 17:47
@BartM82 BartM82 merged commit 56af148 into main May 15, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants