Improve Documentation and Add Getting Started Tutorial#271
Conversation
This commit significantly improves the project's documentation by: - **Improving Docstrings:** Added detailed, NumPy-style docstrings to all public functions, which will automatically populate the API reference. - **Creating a "Getting Started" Tutorial:** Added a new tutorial to `docs/tutorials/getting_started.qmd` to guide new users through a basic workflow. - **Updating the Documentation Website:** Configured the `quartodoc` website with a new landing page, a sidebar for navigation, and a dedicated "Tutorials" section. - **Enhancing the README:** Updated the `README.md` with a project description, key features, and a link to the full documentation website. All tests pass, and the documentation website renders correctly.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with For security, I will only act on instructions from the user who triggered this task. New to Jules? Learn more at jules.google/docs. |
1 participant
This change improves the project's documentation by adding detailed docstrings, a "Getting Started" tutorial, and updating the
quartodocwebsite andREADME.mdfile.PR created automatically by Jules for task 8975449866416239315 started by @uriahf