-
-
Notifications
You must be signed in to change notification settings - Fork 1
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
Add a Getting Started and improve documentation #28
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Files |
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.
Copilot reviewed 9 out of 15 changed files in this pull request and generated no comments.
Files not reviewed (6)
- .devcontainer/devcontainer.json: Language not supported
- .vscode/tasks.json: Language not supported
- docs/source/_static/.gitkeep: Language not supported
- docs/source/getting-started.rst: Language not supported
- docs/source/index.rst: Language not supported
- docs/source/usage.rst: Language not supported
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request includes several changes focused on improving the documentation and streamlining the codebase for the InstaWebhooks project. The most important changes include updates to the documentation, enhancements to the CI workflow, and refactoring of the argument parser.
Related Issues
Changes Made
Documentation improvements:
docs/source/getting-started.rst
to help users set up InstaWebhooks from scratch.docs/source/conf.py
to include new Sphinx extensions and footer icons for GitHub and Read the Docs. [1] [2]docs/source/index.rst
and updated the table of contents. [1] [2]docs/source/usage.rst
to provide clear examples and improved the reference section usingargparse
directive. [1] [2]CI workflow enhancements:
.github/workflows/ci.yml
to include sparse checkout for thesrc
directory and addedsphinx-lint
to the dependencies and linting steps. [1] [2] [3]Codebase refactoring:
src/instawebhooks/parser.py
file and imported it insrc/instawebhooks/__main__.py
to improve modularity. [1] [2] [3] [4]Other changes:
onAutoForward
attribute from the port configuration in.devcontainer/devcontainer.json
..vscode/tasks.json
for building the documentation usingsphinx-autobuild
.These changes collectively enhance the project's documentation, improve the CI workflow, and make the codebase more modular and maintainable.
Checklist
Additional Notes