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

feat: add mkdocs for documentation to deploy to gh-pages #171

Merged
merged 1 commit into from
Oct 10, 2023

Conversation

nmerget
Copy link
Collaborator

@nmerget nmerget commented Oct 7, 2023

  • Add mkdocs to publish the first documentation to GitHub Pages.
  • I gave it the name GodotJS, but we should discuss it ECMAScript is a little bit misleading in my opinion without any reference to godot

@Geequlim what do you think about the name?

We should look at https://github.com/why-try313/godot-ECMAScript-cookbook/wiki for more detailed documentation in a future branch.

@nmerget nmerget requested a review from fire October 7, 2023 21:10
@nmerget nmerget marked this pull request as ready for review October 7, 2023 21:10
@nmerget nmerget marked this pull request as draft October 7, 2023 21:13
Copy link
Collaborator

@fire fire left a comment

Choose a reason for hiding this comment

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

I am not able to review in depth. Typically the type table has desynced and I would check the table and the source to see if it still works. Great work on taking lead on the codebase.

@nmerget
Copy link
Collaborator Author

nmerget commented Oct 9, 2023

I am not able to review in depth. Typically the type table has desynced and I would check the table and the source to see if it still works. Great work on taking lead on the codebase.

Thank you. I'm not really deep into the types, please feel free to change it. Basically, I want some kind of documentation setup and iterate this step by step. I guess the most important thing would be a name for the "app".

@nmerget nmerget linked an issue Oct 9, 2023 that may be closed by this pull request
8 tasks
@Geequlim
Copy link
Collaborator

Geequlim commented Oct 10, 2023 via email

@nmerget nmerget marked this pull request as ready for review October 10, 2023 18:56
@nmerget nmerget merged commit 036434f into godotjs:master Oct 10, 2023
12 checks passed
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.

[Suggestion] Documentation and getting started tutorial
3 participants