Skip to content

Status Update / Increase Overall Documentation Quality - #211

Merged
clauspruefer merged 18 commits into
mainfrom
current-status-update
Aug 13, 2026
Merged

Status Update / Increase Overall Documentation Quality#211
clauspruefer merged 18 commits into
mainfrom
current-status-update

Conversation

@clauspruefer

Copy link
Copy Markdown
Member

Pull Request

Description

Update current status and projects documentation to a much higher level.

Type of Change

  • Documentation update

Copilot AI lite review requested due to automatic review settings August 13, 2026 13:22
@clauspruefer

Copy link
Copy Markdown
Member Author

@copilot Please check for each sub-directory if README.md or any other markup still reflects the current source code / content of the project. Also check sub-directories where no README.md exists. Rewrite the found README.md when it does not reflect the content with a high quality approach. Also do this for not existing README.md, write them with a high quality standard but it must match the already existing documentation style of the project.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md into 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.

Comment thread README.md Outdated
@clauspruefer

Copy link
Copy Markdown
Member Author

@copilot are you working on my last request?

clauspruefer and others added 6 commits August 13, 2026 15:30
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>

Copilot AI commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

@copilot Please check for each sub-directory if README.md or any other markup still reflects the current source code / content of the project. Also check sub-directories where no README.md exists....

Addressed in 88076ec. I audited the repository subdirectories, rewrote outdated README content, and added missing README files so the directory-level documentation now matches the current source layout and content.

Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>

Copilot AI commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

@copilot are you working on my last request?

I rechecked the directory-level docs and fixed one remaining mismatch in test/integration/signal-termination/README.md. Addressed in 063152a.

@clauspruefer
clauspruefer merged commit 9987be6 into main Aug 13, 2026
5 of 6 checks passed
@clauspruefer
clauspruefer deleted the current-status-update branch August 14, 2026 07:22
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.

3 participants