Skip to content

Comments

Improve documentation: README, development guide, and examples#650

Open
sorrentmutie wants to merge 5 commits intodbader:masterfrom
sorrentmutie:ai-docs-demo
Open

Improve documentation: README, development guide, and examples#650
sorrentmutie wants to merge 5 commits intodbader:masterfrom
sorrentmutie:ai-docs-demo

Conversation

@sorrentmutie
Copy link

Summary

  • Add project structure overview and key API concepts to README
  • Document platform requirements for timezone tests (WSL/Docker alternatives for Windows)
  • Add simple example script (example.py)
  • Include internal documentation guidelines in .claude/ directory

Test plan

  • Verify README renders correctly on GitHub
  • Confirm documentation builds without errors
  • Review example script runs as expected

🤖 Generated with Claude Code

- Documented the testing framework and how to run tests in README.rst.
- Added platform requirements for timezone tests in development.rst.
- Introduced an example script demonstrating basic scheduling functionality.
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