Skip to content
This repository has been archived by the owner on Mar 19, 2023. It is now read-only.

Add Adventure Javadocs to Javadocs page #80

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Adventure Javadocs to Javadocs page #80

wants to merge 1 commit into from

Conversation

aurorasmiles
Copy link
Contributor

Closes #79

Proximyst
Proximyst approved these changes Mar 27, 2021
View reviewed changes
Copy link
Contributor

@Proximyst Proximyst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like a good idea to me. Perhaps also worth adding a note in the Paper pom(s) that this needs updating if we update it over there?

Trigary
Trigary suggested changes Mar 27, 2021
View reviewed changes
Copy link

@Trigary Trigary left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a line further up: "You can view the javadocs for specific versions of Paper or Waterfall below."
That line should probably be modified, as now JavaDocs other than Paper's and Waterfall's are linked on the page.

@kashike
Copy link
Member

kashike commented Mar 27, 2021

Sounds like a good idea to me. Perhaps also worth adding a note in the Paper pom(s) that this needs updating if we update it over there?

Definitely this.

@aurorasmiles
Copy link
Contributor Author

Sounds like a good idea to me. Perhaps also worth adding a note in the Paper pom(s) that this needs updating if we update it over there?

Definitely this.

PR opened: PaperMC/Paper#5422

kashike
kashike reviewed Mar 27, 2021
View reviewed changes
src/javadocs.twig
<h3>Adventure</h3>
<p>Javadocs for the Adventure API (included in Paper) can be found below.</p>
<div>
<a href="https://jd.adventure.kyori.net/api/4.7.0/" class="waves-effect waves-light btn light-blue darken-2">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not include javadocs for the other projects we package - might be good to have a dropdown?

  • API
  • JSON
  • Legacy

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alternative would be to have those buttons inline

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Plain serializer is also included - also, the version is out of date here as well.

@MiniDigger MiniDigger force-pushed the master branch 2 times, most recently from db4e96d to c3ee750 Compare September 1, 2021 18:59
@zml2008
Copy link

zml2008 commented Jan 5, 2022

We now have an index page that could be directly linked to, plus latest version aliases for every module (for example, https://jd.adventure.kyori.net/api/latest/) that could reduce the maintenance burden on keeping these links up to date. Is it worth revisiting this PR using those new resources?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@kezz kezz kezz left review comments

@MiniDigger MiniDigger MiniDigger left review comments

@kashike kashike kashike left review comments

@Trigary Trigary Trigary requested changes

@Proximyst Proximyst Proximyst approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Link Adventure JavaDocs
7 participants
@aurorasmiles @kashike @zml2008 @kezz @MiniDigger @Trigary @Proximyst