FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Velocity Documentation by DerEchtePilz · Pull Request #521 · CommandAPI/CommandAPI · GitHub

Velocity Documentation - #521

Merged
DerEchtePilz merged 7 commits into
dev/devfrom
velocity-docs
Feb 27, 2024
Merged

Velocity Documentation#521
DerEchtePilz merged 7 commits into
dev/devfrom
velocity-docs

Conversation

Copy link
Copy Markdown
Member

This is supposed to add a bit of Velocity documentation to the documentation.

Feel free to suggest anything else that you think should be added!

JorelAli commented Feb 23, 2024
edited
Loading

Copy link
Copy Markdown
Member

I've been thinking of this a bit more - if we're going to have a clear separation between sections and chapters in our documentation, would it be easier to maintain (and more well-structured) to format the directory structure as well? I believe mdBook allows directories for its SUMMARY.md file, so we could have something like...

.
├── velocity
│   └── velocity_intro.md
└── spigot
    └── (everything else)

We could also continue this with something like...

.
├── velocity
│   └── velocity_intro.md
└── spigot
    ├── arguments
    │   ├── argument_whatever1.md
    │   ├── argument_whatever2.md
    │   └── ...
    └── annotations
        └── ...

Just a thought. Not sure how relevant this is at this stage, but if we continue branching out to different platforms (fabric, forge, sponge, etc.), it's probably worth considering.

Copy link
Copy Markdown
Member Author

Yeah, it probably makes sense adding something like that.
However, I do think it's not necessary now but should be something to add for 10.0.0 when we actually do release Velocity.
For now it's probably sufficient to be able to link people to that page if they ask about Velocity support before we release 10.0.0.

Copy link
Copy Markdown
Collaborator

Maybe we could also bring the documentation-code structure together with the docssrc files. Something like this maybe?

commandapi-documentation/
├─ pom.xml
├─ docssrc/
│  └─ intro.md
├─ bukkit/
│  ├─ docssrc/
│  │  ├─ bukkit_intro.md
│  │  ├─ arguments/
│  │  │  ├─ argument_whatever1.md
│  │  │  ├─ argument_whatever2.md
│  │  │  └─ ...
│  │  └─ annotations/
│  │     └─ ...
│  └─ commandapi-documentation-bukkit-code/
│     ├─ src/main/.../
│     └─ pom.xml
└─ velocity/
   ├─ docssrc/
   │  └─ velocity_intro.md
   └─ commandapi-documenatation-velocity-code/
      ├─ src/main/.../
      └─ pom.xml

That way, for example, when you're working with the bukkit documentation pages bukkit/docssrc, you're simply one directory away from documentation examples bukkit/commandapi-documentation-bukkit-code.

Or maybe we could completely merge the documentation-code and docssrc files like so:

commandapi-documenation/
├─ pom.xml
├─ src/
│  └─ main/
│     └─ intro.md
├─ commandapi-documenation-bukkit/
│  ├─ pom.xml
│  └─ src/
│     └─ main/
│        ├─ bukkit_intro.md
│        ├─ arguments/
│        │  ├─ argument1.md
│        │  ├─ argument1.java
│        │  ├─ argument1.kt
│        │  ├─ argument2.md
│        │  ├─ argument2.java
│        │  ├─ argument2.kt
│        │  └─ ...
│        └─ annotations/
│           └─ ...
└─ commandapi-documentation-velocity/
   ├─ pom.xml
   └─ src/
      └─ main/
         ├─ velocity_intro.md
         ├─ randomNumberCommand.java
         ├─ randomNumberCommand.kt
         └─ randomNumberCommandDSL.kt

I'm not sure if mdBook, Java, or Kotlin like all those files in the same place, but it would make it very easy to find the files that hold the code that documentation pages reference. Individual code files for each documentation page might be easier to understand than monolithic Example classes that hold everything.

But yeah, that's probably not something we need to set up now for a single page about Velocity.

Copy link
Copy Markdown
Member Author

For this PR, I intentionally paid attention to not change any existing documentation code locations because that would need to be updated in the pages as well which to be honest I deemed to not be within the scope of this PR.
During 9.0.0 development, I sorted the examples alphabetically and with the method they are in you also find the page rather quickly. The class, however, is quite big so splitting that up to a per-page class might also help.
With #517 I am also already trying to introduce platform specific documentation so something like this maybe should wait.

willkroboth self-requested a review February 23, 2024 18:19

willkroboth left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Just a few notes. Maybe once we do some more Velocity docs it would make sense to restructure, but this PR definitely achieves the goal of letting people know Velocity CommandAPI exists.

Comment thread commandapi-documentation-code/pom.xml Outdated
Comment thread pom.xml Outdated

Copy link
Copy Markdown
Member Author

Maybe once we do some more Velocity docs it would make sense to restructure

No argument here. Restructuring definitely makes sense but also definitely doesn't fit into this PR.

Also thanks for the few notes. I'll do them all locally but will add you as a co-author for the suggested changes as GitHub would do the same.

DerEchtePilz merged commit 311bf62 into dev/dev Feb 27, 2024
willkroboth added a commit that referenced this pull request Feb 29, 2024


Loading Velocity now requires a reference to the plugin class for registering events
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants


Back | FazBrowse Home | New Git URL