Skip to content

Add tutorial and update documentation#14

Merged
hfern merged 2 commits into
masterfrom
hgf/docs
Aug 29, 2025
Merged

Add tutorial and update documentation#14
hfern merged 2 commits into
masterfrom
hgf/docs

Conversation

@hfern
Copy link
Copy Markdown
Owner

@hfern hfern commented Aug 27, 2025

Removes the caveat about not being able to get production, as I feel that's now a viable path.
Switches recommendation from using nuitka to pex, which I have had good experience with.
Adds a simple step-by-step tutorial for starting a new provider. It's modeled on the e2e example.

See the docs preview at: https://python-tf--14.org.readthedocs.build/en/14/index.html

This comment was marked as outdated.

@hfern hfern requested a review from Copilot August 27, 2025 08:13

This comment was marked as outdated.

@hfern hfern requested a review from Copilot August 29, 2025 03:44
Copy link
Copy Markdown

Copilot AI left a 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 adds comprehensive documentation improvements including a new tutorial for creating providers and updates recommendations for building production binaries. The changes shift the focus from discouraging production use to providing practical guidance.

  • Adds a step-by-step tutorial for creating a math provider with data sources
  • Updates binary building recommendations from Nuitka to Pex
  • Removes production warnings and adds tips/tricks documentation

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
tf/types.py Improves documentation for the Unknown sentinel value
tf/iface.py Moves type alias definitions above their docstrings for better code organization
src/tf/init.py Adds a simple main function placeholder
docs/tutorial.rst Comprehensive new tutorial covering provider creation from setup to data sources
docs/tips_tricks.rst New documentation for debugging and binary building guidance
docs/index.rst Updates table of contents and removes production warning
docs/caveats.md Updates binary building recommendations from Nuitka to Pex
docs/api.rst Expands API documentation with better explanations and Config type documentation
CHANGELOG.md Documents the addition of the tutorial

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread tf/types.py
Comment thread tf/iface.py
Comment thread tf/iface.py
@hfern hfern merged commit 0361189 into master Aug 29, 2025
6 checks passed
@hfern hfern deleted the hgf/docs branch September 17, 2025 00:44
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.

3 participants