Skip to content

Documentation update and minor fixes#20

Merged
ryanmphill merged 4 commits intomainfrom
documentation-update-and-minor-fixes
Dec 3, 2025
Merged

Documentation update and minor fixes#20
ryanmphill merged 4 commits intomainfrom
documentation-update-and-minor-fixes

Conversation

@ryanmphill
Copy link
Copy Markdown
Owner

This pull request makes several updates to improve documentation, package metadata, and project distribution. The main changes include updating the README.md for better clarity and PyPI installation instructions, removing the unused Pipfile, adding missing files to the package manifest, and bumping the package version.

Documentation and usage improvements:

  • Updated README.md to:
    • Use PyPI badges and installation instructions instead of GitHub-based ones.
    • Clarify key features, installation, and usage steps.
    • Improve Jinja query examples and configuration documentation.
    • Simplify Netlify deployment instructions and clarify Python version requirements.
    • Refine development setup steps. [1] [2] [3] [4] [5] [6] [7] [8]

Packaging and distribution:

  • Removed the unused Pipfile to clean up dependency management and avoid confusion.
  • Added shodo_ssg/project_template/.gitignore to MANIFEST.in to ensure all necessary template files are included in package distributions.
  • Bumped the package version in pyproject.toml from 0.0.dev3 to 0.0.dev4 to reflect these changes and prepare for a new release.

@ryanmphill ryanmphill merged commit a928edb into main Dec 3, 2025
6 checks passed
@ryanmphill ryanmphill deleted the documentation-update-and-minor-fixes branch December 3, 2025 18:41
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.

1 participant