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

A patches page #4

Open
granny opened this issue Mar 16, 2021 · 0 comments
Open

A patches page #4

granny opened this issue Mar 16, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@granny
Copy link
Member

granny commented Mar 16, 2021

This page would explain every patch that Purpur adds with a categorized list of the feature, performance stuff, API stuff, etc.

It would be categorized by api & server, with headers being the filename of the patch. Each patch would include a hyperlink to the patch in Purpur.

/patches
## api
  ### This-Is-A.patch
    description:
    reason?:
    permissions:
    options:
  ### This-Is-Another.patch
    description:
    reason?:
    permissions:
    options:
## server
  ### This-Is-A.patch
    description:
    reason?:
    permissions:
    options:
  ### This-Is-Another.patch
    description:
    reason?:
    permissions:
    options:

Truncating the number from the filename would make it less difficult to keep it up-to-date with Purpur incase patches get reorganized or renamed.

  • description will explain what that patch does
  • reason will explain why this patch was added
  • permissions will list any permissions that the patch adds
  • options will list any options that the patch adds

Not really sure how to format this page but these are my inital thoughts. The format may change from what is listed here depending on feedback from others or how it looks in the end.

@granny granny added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 16, 2021
encode42 added a commit that referenced this issue Dec 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant