Status Update / Increase Overall Documentation Quality - #211
Conversation
|
@copilot Please check for each sub-directory if |
There was a problem hiding this comment.
Pull request overview
This PR refreshes the repository’s documentation and specifications by replacing the previous long-form root README with a more structured project overview, cleaning up the specs/ index docs, and adding a new YANG model to complement the existing XML/DTD specification set.
Changes:
- Added an initial YANG 1.1 model for NLAP derived from the existing DTD.
- Simplified and restructured the root
README.mdinto a shorter, more formal overview. - Updated
specs/documentation and removed the placeholder NLASP XML spec page and its README entry.
Reviewed changes
Copilot reviewed 4 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| specs/yang/nlap.yang | Introduces a YANG data model for NLAP messages and shared fields (converted from the DTD). |
| specs/xml/README.md | Removes NLASP from the XML specs index list. |
| specs/xml/NLASP-XML-SPECS.md | Deletes the NLASP placeholder specification page. |
| specs/README.md | Updates the specs/ landing page to reflect current folder structure (XML/YANG/DB). |
| README.md | Replaces the previous long README with a new structured overview and updated badges/links. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
@copilot are you working on my last request? |
Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>
Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>
Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>
Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>
Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>
Addressed in |
Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>
I rechecked the directory-level docs and fixed one remaining mismatch in |
Pull Request
Description
Update current status and projects documentation to a much higher level.
Type of Change