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

iOS Plugin documentation #4194

Closed
wants to merge 2 commits into from

Conversation

naithar
Copy link
Contributor

@naithar naithar commented Oct 2, 2020

Related PRs for Godot: master godotengine/godot#41230, 3.2 godotengine/godot#41340
Proposal: godotengine/godot-proposals#1185

Adds a starting documentation for iOS plugin system implemented in linked PRs.
I've used Android plugin documentation as an example.

Header files could probably be made available just like Android's plugin .aar.

@Calinou Calinou added enhancement content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features and removed enhancement labels Oct 2, 2020
Comment on lines 1 to 2
iOS plugins
===============
Copy link
Member

Choose a reason for hiding this comment

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

The number of characters below a heading must match the heading above:

Suggested change
iOS plugins
===============
iOS plugins
===========

This is a Sphinx/reStructuredText requirement. Make sure to do this for all the headings you've added.

@NathanLovato
Copy link
Contributor

Related to #4163

Thanks for the contribution. Would you mind if I directly edited the document to make the style fit our writing guidelines? https://docs.godotengine.org/en/latest/community/contributing/docs_writing_guidelines.html

You can check the guidelines and do it yourself if you'd like. I'm offering to edit for you because it's much more efficient than leaving you dozens of review comments.

@NathanLovato NathanLovato added this to the Godot 4.0 milestone Oct 3, 2020
@naithar
Copy link
Contributor Author

naithar commented Oct 3, 2020

Would you mind if I directly edited the document to make the style fit our writing guidelines?

If you think it's more efficient, sure, I wouldn't mind.

@NathanLovato
Copy link
Contributor

I opened a new PR with some WIP edits. I hadn't noticed the feature wasn't merged in the engine; we should review and merge the docs only after a feature was added to Godot.

@naithar
Copy link
Contributor Author

naithar commented Oct 7, 2020

I opened a new PR with some WIP edits. I hadn't noticed the feature wasn't merged in the engine; we should review and merge the docs only after a feature was added to Godot.

Sorry, should have made it more clear in OP.

And it's also strange that you couldn't push directly to this PR as I have enabled edit by maintainers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants