docs: add document how to define outbox

[AmaseCocoa]

resolve #17

[gemini-code-assist]

Summary of Changes

Hello @AmaseCocoa, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's documentation by introducing a comprehensive guide on implementing ActivityPub Outbox functionality. It provides clear instructions and examples for developers to integrate this core ActivityPub component. Additionally, the pull request includes necessary updates to the documentation build system's dependencies and configuration to ensure compatibility and proper rendering of the new content.

Highlights

• New Outbox Documentation: A new guide has been added to the documentation, explaining how to define and implement ActivityPub Outbox functionality, complete with code examples for both empty and real data returns.
• Documentation Site Configuration Update: The mkdocs.yml file was updated to reflect a new site_url and to integrate the newly created Outbox guide into the navigation menu.
• Dependency Version Updates: Documentation-related dependencies, specifically mkdocs-material, backrefs, and click, have had their versions updated and locked in pyproject.toml and uv.lock.

Changelog

• docs/guides/outbox.md
  • Added a new guide explaining how to define and implement an ActivityPub Outbox.
  • Included Python code examples for setting up an empty Outbox and returning real, paginated activity data.
  • Provided a tip explaining the purpose and usage of the Tombstone type in Outbox responses.
• mkdocs.yml
  • Updated the site_url from fedi-libs.github.io/apkit to apkit.fedi-libs.org.
  • Added the new 'Outbox' guide to the documentation navigation menu.
• pyproject.toml
  • Updated the mkdocs-material dependency to a fixed version 9.6.20.
• uv.lock
  • Updated the locked version of mkdocs-material from 9.7.1 to 9.6.20.
  • Downgraded the locked version of backrefs from 6.1 to 5.9.
  • Downgraded the locked version of click from 8.3.1 to 8.2.1.
  • Added click as a direct dependency for mkdocs-material within the lock file.

Activity

• The pull request was created to resolve issue Example for outbox #17, indicating it addresses a specific, previously identified task or need.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[gemini-code-assist]

Code Review

This pull request adds documentation for implementing an outbox. The changes to the project configuration and lock files seem appropriate for the documentation updates. The new documentation file docs/guides/outbox.md is a great addition, but I've found several areas where the clarity and correctness of the examples and explanations can be improved. My review includes suggestions to fix grammatical errors, improve phrasing, and correct the code examples to make them complete and runnable. Addressing these points will make the documentation much more helpful for users.