-
Notifications
You must be signed in to change notification settings - Fork 3
Docs update #70
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs update #70
Conversation
There was a problem hiding this comment.
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 updates project documentation and metadata across multiple files. The main focus is on improving project information, author details, and documentation structure.
- Updated project metadata in pyproject.toml with detailed author information, enhanced description, and specific package data
- Added comprehensive Docker installation documentation
- Enhanced README with status badges and improved navigation
- Updated workflow name for better clarity
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| withdraw_expired | Removed empty file |
| pyproject.toml | Enhanced project metadata with detailed authors, maintainers, keywords, and specific package data configuration |
| flowapp/about.py | Added project metadata constants |
| docs/DockerImage.md | Added comprehensive Docker installation and configuration guide |
| README.md | Added status badges and Docker documentation link |
| .github/workflows/python-app.yml | Updated workflow name from "Python application" to "PyTest" |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
pyproject.toml
Outdated
| Repository = "https://github.com/CESNET/exafs" | ||
| Documentation = "https://github.com/CESNET/exafs/blob/master/README.md" | ||
| Issues = "https://github.com/CESNET/exafs/issues" | ||
| Changelog = "https://github.com/CESNET/exafs/blob/master/README.md#change-log" |
Copilot
AI
Oct 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The changelog URL points to a section that doesn't exist in the README.md file. Verify that the '#change-log' anchor exists or update the URL to point to the correct location.
| Changelog = "https://github.com/CESNET/exafs/blob/master/README.md#change-log" | |
| Changelog = "https://github.com/CESNET/exafs/blob/master/CHANGELOG.md" |
Co-authored-by: Copilot <[email protected]>
Updated documentation