Create documentation

[SlimaneAmar]

PR Summary

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a9a05491-e3b8-4aee-a817-6126ec4541d9

📥 Commits

Reviewing files that changed from the base of the PR and between 52b0197 and 0bf310a.

📒 Files selected for processing (3)

• README.md
• docs/API.md
• docs/ARCHITECTURE.md

---

📝 Walkthrough

Walkthrough

Adds two new documentation files (docs/ARCHITECTURE.md and docs/API.md) for the gridsuite-network-modification library, covering architecture, core abstractions, DTO hierarchy, design patterns, exception types, enums, and Java usage examples. README.md is updated to link to both documents.

Changes

Library Documentation

Layer / File(s)	Summary
README documentation links README.md	Inserts a Documentation subsection with links to the new architecture and API reference files.
Architecture overview docs/ARCHITECTURE.md	New file covering library purpose, technology stack, package structure, core abstractions (AbstractModification, ModificationInfos), all supported modification categories, key design patterns (factory conversion, attribute patching, polymorphic JSON, reporting, DI), error handling, end-to-end data flow, and a package responsibility table.
API reference docs/API.md	New file with Maven coordinates, service interface contracts (IFilterService, ILoadFlowService), AbstractModification lifecycle methods, ModificationInfos base DTO and ModificationType enum, the full DTO hierarchy across equipment creation/modification/deletion/topology/scaling/bulk/operational/composite categories, AttributeModification<T> semantics, NetworkModificationException type table, supporting enums, Java usage examples, and a version footer for 0.88.0-SNAPSHOT.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The pull request description is a template with no actual content provided, making it impossible to assess relevance to the changeset.	Provide a meaningful description that summarizes what documentation was added and why, even if brief.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Create documentation' is clearly related to the changeset, which adds three documentation files (README.md updates, docs/API.md, and docs/ARCHITECTURE.md).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud