Skip to content

Add developer docs#3

Merged
octylFractal merged 8 commits intomasterfrom
feature/developer-docs
Jan 4, 2020
Merged

Add developer docs#3
octylFractal merged 8 commits intomasterfrom
feature/developer-docs

Conversation

@octylFractal
Copy link
Copy Markdown
Member

@octylFractal octylFractal commented Dec 20, 2019

This PR adds the long-awaited developer documentation for WorldEdit.

This PR is currently under construction, but feedback is still requested to ensure that the documentation is understandable.

Preview at: https://octyl.net/engine-hub/WorldEditDocs-preview/api/

@wizjany
Copy link
Copy Markdown
Contributor

wizjany commented Dec 22, 2019

Initial thoughts:
I like the separation between concept and example, and linking the used concepts in example pages.
I think the entire abstraction layer should be a concept page, and maybe have some examples of adapter usage.
Not sure if it's mentioning some more details in the game like the default pastebuilder settings? eg entities are copied by default and air is not ignored by default, but the clipboard examples set both of those things (to the default).

@Joo200
Copy link
Copy Markdown
Contributor

Joo200 commented Dec 22, 2019

Maybe link the source code from the current commands as examples?
Most of the things are covered in those commands, for the usage from external plugins there are only small adjustment (get LocalSession, EditSession etc.)

@octylFractal
Copy link
Copy Markdown
Member Author

I would rather not, there is a lot of unnecessary code and handling in the command methods that will distract from the examples.

@octylFractal
Copy link
Copy Markdown
Member Author

I think that while this may not provide full documentation, it provides a good start, and can be contributed to more easily. I'd like to merge this with the content it has now, but if there are comments on the existing content, I'd be happy to incorporate them. Expansions can be handled as either direct commits (EH members) or PRs (others).

@octylFractal octylFractal marked this pull request as ready for review December 30, 2019 03:47
@octylFractal octylFractal merged commit f9c66b2 into master Jan 4, 2020
@octylFractal octylFractal deleted the feature/developer-docs branch January 4, 2020 21:54
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