Skip to content

Update documentation for bensolve 2.1.0 migration - #128

Merged
markobud merged 3 commits into
developmentfrom
copilot/check-documentation-prior-to-main
Feb 7, 2026
Merged

Update documentation for bensolve 2.1.0 migration#128
markobud merged 3 commits into
developmentfrom
copilot/check-documentation-prior-to-main

Conversation

Copilot AI commented Feb 7, 2026

Copy link
Copy Markdown
Contributor

Documentation contained outdated references to bensolve-mod after the migration to bensolve 2.1.0. One reference was a packaging bug.

Critical Fix

MANIFEST.in - Corrected source file paths from non-existent bensolve-mod/ to bensolve-2.1.0/

-include src/bensolve-mod/*.c
-include src/bensolve-mod/*.h
+include src/bensolve-2.1.0/*.c
+include src/bensolve-2.1.0/*.h

Without this fix, source distributions would be incomplete.

Developer Documentation

  • .github/copilot-instructions.md - Updated project structure paths and version references
  • .github/agents/{dev_base,crossplatform-compiler,security-agent}.md - Updated file paths to bensolve-2.1.0
  • tools/ - Marked migration scripts as deprecated/historical

Historical Context Preserved

Intentionally kept bensolve-mod references where they document migration history:

  • CHANGELOG.md - Migration documentation
  • README.md - Listed under "Related Projects (legacy)"
  • doc/*.md - API comparison sections for developers
  • tools/diff_headers.sh - Historical comparison utility

Report

Added CODE_ISSUES_REPORT.md documenting all findings and non-issues.

Original prompt

This section details on the original issue you should resolve

<issue_title>Check documentation prior to PR to main and mark new releases</issue_title>
<issue_description>This issue tracks documentation issues and references to the old bensolve-mod module that was used in previous version</issue_description>

<agent_instructions>Please, only focus on docs and comments. If you spot code inconsistencies, report in a dedicated file</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@markobud My bad, I should specify that this was meant for the development branch

Custom agent used: Documentation Expert
Revise and update documentation


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits February 7, 2026 17:04
Co-authored-by: markobud <93592045+markobud@users.noreply.github.com>
Co-authored-by: markobud <93592045+markobud@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation and mark new releases for bensolve-mod Update documentation for bensolve 2.1.0 migration Feb 7, 2026
Copilot AI requested a review from markobud February 7, 2026 17:06
@markobud
markobud marked this pull request as ready for review February 7, 2026 17:08
@github-actions

github-actions Bot commented Feb 7, 2026

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@markobud
markobud merged commit 5a80755 into development Feb 7, 2026
43 checks passed
@markobud
markobud deleted the copilot/check-documentation-prior-to-main branch February 7, 2026 17:47
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