Skip to content
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
merged 39 commits into from
Dec 27, 2024
Merged

Add a Getting Started and improve documentation #28

merged 39 commits into from
Dec 27, 2024

Conversation

RyanLua
Copy link
Owner

@RyanLua RyanLua commented Dec 25, 2024

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:

  • Added a new "Getting Started" guide in docs/source/getting-started.rst to help users set up InstaWebhooks from scratch.
  • Updated docs/source/conf.py to include new Sphinx extensions and footer icons for GitHub and Read the Docs. [1] [2]
  • Added new features and customization options to the docs/source/index.rst and updated the table of contents. [1] [2]
  • Refined the docs/source/usage.rst to provide clear examples and improved the reference section using argparse directive. [1] [2]

CI workflow enhancements:

  • Modified the .github/workflows/ci.yml to include sparse checkout for the src directory and added sphinx-lint to the dependencies and linting steps. [1] [2] [3]

Codebase refactoring:

  • Extracted the argument parser logic into a new src/instawebhooks/parser.py file and imported it in src/instawebhooks/__main__.py to improve modularity. [1] [2] [3] [4]

Other changes:

  • Removed the onAutoForward attribute from the port configuration in .devcontainer/devcontainer.json.
  • Added a new task in .vscode/tasks.json for building the documentation using sphinx-autobuild.

These changes collectively enhance the project's documentation, improve the CI workflow, and make the codebase more modular and maintainable.

Checklist

  • I have tested these changes thoroughly.
  • I have reviewed my code for any potential errors or issues.
  • I have followed the code style guidelines for this project.

Additional Notes

@RyanLua RyanLua added the documentation Improvements or additions to documentation label Dec 25, 2024
@RyanLua RyanLua added this to the v0.1.4 milestone Dec 25, 2024
@RyanLua RyanLua requested a review from Copilot December 25, 2024 04:20
@RyanLua RyanLua self-assigned this Dec 25, 2024
Copy link

github-actions bot commented Dec 25, 2024

Dependency Review

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

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Files

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
@RyanLua RyanLua merged commit 7fb764e into main Dec 27, 2024
4 checks passed
@RyanLua RyanLua deleted the polish-docs branch December 27, 2024 07:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant