Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lightweight: Documentation #172

Open
wants to merge 57 commits into
base: version/1.1.6
Choose a base branch
from

Conversation

ItsNature
Copy link
Collaborator

@ItsNature ItsNature commented Sep 6, 2024

Overview

Description:
This update enhances documentation for Apollo’s Lightweight integration, providing comprehensive examples for each integration type. It includes guides on detecting Apollo players, listening for Apollo packets, and utilizing utilities to simplify integration.

Changes:

apollo-bukkit-example

A new Lightweight directory was added to the documentation page.

Added Protobuf and JSON code examples for each Apollo module, providing sample integration snippets on every module documentation page. These examples offer direct guidance for implementing Apollo features across different integration methods.

For instance, sample code for the BorderModule is available in its Sample Code section on the BorderModule page.


Review Request Checklist

  • Your code follows the style guidelines of this project.
  • I have performed a self-review of my code.
  • I have tested this change myself. (If applicable)
  • I have made corresponding changes to the documentation. (If applicable)
  • The branch name follows the projects naming conventions. (e.g. feature/add-module & bugfix/fix-issue)

@ItsNature ItsNature changed the title Feature/lightweight example plugin Feature - Lightweight example plugin Sep 6, 2024
@ItsNature ItsNature changed the title Feature - Lightweight example plugin Lightweight - Documentation Oct 7, 2024
@ItsNature ItsNature added the type: Documentation Documentation improvement or issue label Oct 7, 2024
@ItsNature ItsNature requested review from vectrixdevelops and TrentinTheKid and removed request for vectrixdevelops October 7, 2024 14:11
@ItsNature ItsNature marked this pull request as ready for review October 7, 2024 14:11
@ItsNature ItsNature changed the title Lightweight - Documentation Lightweight: Documentation Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: Documentation Documentation improvement or issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants