Skip to content

Online documentation for ProtocolExtension #1

@Olafcio1

Description

@Olafcio1

A good idea would be to make an online documentation, with a tool like PacketEvents uses, to cover all topics about ProtocolExtension:

  1. All custom payloads: (sometimes named packets)
    There will be more and more features that PX has, which will most certainly be new payloads. Reading code for a method as an only source to learn about a payload might not explain it too accurate, nor be easy for a beginner to understand.

  2. Code examples:
    There's not much space for usage examples in the code, and they clutter a lot of space.

  3. Browsing all features:
    Some features may be hidden or not accessible as you would think. You can browse files or package autocompletion with your IDE, but that's a pain in the butt, and is absolutely unacceptable for beginners.

But, the websites I know that exactly fit my use had issues regarding free usage:

  1. GitBook - Forced open-source project (ok), application for community plan (which I don't even know if they accept), lies regarding a non-community free plan (it doesn't exist, even though they claimed it did)

  2. Outline - No cloud free plan, not written in PHP (can't self-host on a free website hosting service)

I didn't check other sites, as I'm busy with other things, and there might not even be an alternative which would fix these issues.

If you made a project like this or found one which doesn't have these issues, feel free to suggest it in the comments.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationmajorThis may require making another project or a lot of engagementorg-relatedIssue not necessarily related to code, but rather the project documentation or its social pages

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions