doc(py): a bit more clarity and cleanup

skyl commented 1 week ago

Documentation, Enhancement

Removed the empty entrypoint.sh script from the .devcontainer directory.
Updated md/README.md to clarify the purpose of the md/ directory and updated the setup guide link.
Deleted md/SETUP.md as it contained outdated setup instructions.
Enhanced py/README.md with a comprehensive overview of the Python codebase, including package descriptions and development workflow.

Relevant files

Miscellaneous

entrypoint.sh

Remove empty entrypoint script

.devcontainer/entrypoint.sh - Removed the `entrypoint.sh` script as it was empty.

+0/-3

Documentation

README.md `Update README with directory purpose and setup link` md/README.md Updated the description of the `md/` directory. Changed the setup guide link to point to the DevContainer setup.	+2/-2
SETUP.md `Remove outdated setup instructions` md/SETUP.md - Removed the `SETUP.md` file entirely.	+0/-22
README.md `Revise Python codebase documentation with detailed overview` py/README.md Revised the overview and structure of the Python codebase documentation. Added detailed descriptions of packages and development workflow.	+24/-23

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

github-actions[bot] commented 1 week ago

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No major issues detected

github-actions[bot] commented 1 week ago

No code suggestions found for the PR.