feat(velocity): document velocity-plugin.json file#735
feat(velocity): document velocity-plugin.json file#735Strokkur424 wants to merge 7 commits intomainfrom
Conversation
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
src/content/docs/velocity/dev/getting-started/velocity-plugin-json.mdx
Outdated
Show resolved
Hide resolved
|
I think it should either be mentioned what the name and ID are actually for, because most logging just uses the ID so either that should be refactored, or this behaviour be documented. (The name is also mostly in-game facing) |
… field headers with list entries, move sidebar entry, add note inside creating-your-first-plugin
src/content/docs/velocity/dev/getting-started/creating-your-first-plugin.mdx
Outdated
Show resolved
Hide resolved
|
Also I'm not sure how to address that but the fields are kinda duplicated now: |
|
|
||
| ```json title=velocity-plugin.json | ||
| { | ||
| "id": "example-plugin", // required |
There was a problem hiding this comment.
I don't think the Velocity plugin file is JSONC to allow comments and I expect some people will copy-paste the code block and wonder why it doesn't work; using line markers from EC might be the way to go: https://expressive-code.com/key-features/text-markers/#adding-long-labels-on-their-own-lines
There was a problem hiding this comment.
Oh yeah, that's a thing. Thank you for the suggestion!
closes #731
I actually decided against outright removing mentions of the AP, as it is useful for beginners and honestly doesn't really hurt most people. But having the actual file documented seems like a good thing.