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

Integrated reference #55

Open
sbrl opened this issue May 21, 2021 · 3 comments
Open

Integrated reference #55

sbrl opened this issue May 21, 2021 · 3 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@sbrl
Copy link
Owner

sbrl commented May 21, 2021

As WorldEditAdditions grows, so too does the number of commands we have - and the documentation thereof.

It would be of significant benefit if we could display our own formspec-based help GUI that automatically parses Chat-Command-Reference.md. /help for example does this already to display the current commands categorised by the mods they are from.

A sensible direction to head in might be to integrate with the doc mod. The API thereof can be found here: https://repo.or.cz/minetest_doc.git/blob/HEAD:/API.md.

Care must be taken here to keep a single source of truth for our documentation - that way it'll stay easy to update.

@sbrl sbrl added the enhancement New feature or request label May 21, 2021
@VorTechnix
Copy link
Collaborator

We should probably also have better categorization of our commands e.g. Fillers, Shape Generators, Terrain Modifiers etc.

@sbrl
Copy link
Owner Author

sbrl commented May 27, 2021

Better categorisation is also something to look into! Currently the canonical categorisation is that in the quick reference guide. I'm open to suggestions if you have a better way off categorising them :-)

@sbrl
Copy link
Owner Author

sbrl commented May 30, 2021

Unfortunately, Minetest doesn't allow you to read from files outside the mod directory - even if you're part of a modpack you can't read from the main modpack directory. Furthermore, symlinks don't help.

This means that we can't automatically read in and parse Chat-Command-Reference.md because read access thereto is blocked.

If anyone has a workaround for this that does not involve moving the existing Chat-Command-Reference.md, please do comment here.

@sbrl sbrl added the help wanted Extra attention is needed label May 30, 2021
sbrl added a commit that referenced this issue May 30, 2021
…ommand-Reference (symlinks don't help), we can't continue this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants