Skip to content

Add images and refine Getting Started section.#47

Merged
ephread merged 14 commits into
ephread:mainfrom
videlanicolas:main
Nov 19, 2021
Merged

Add images and refine Getting Started section.#47
ephread merged 14 commits into
ephread:mainfrom
videlanicolas:main

Conversation

@videlanicolas
Copy link
Copy Markdown
Contributor

@videlanicolas videlanicolas commented Nov 19, 2021

Checklist for this pull request

Description

This merge adds step by step images to better showcase how to install this addon.
Aside from installing it from AssetLib in Godot, the user must add runtime.gd as a singleton.
I'm also re-designing the sections to have them behave with sub-sections.
Since I'm using Visual Studio Code to do my coding, add .vscode to .gitignore, there are no project files to import there.

@videlanicolas videlanicolas marked this pull request as ready for review November 19, 2021 09:22
@ephread
Copy link
Copy Markdown
Owner

ephread commented Nov 19, 2021

LGTM!

There's just a lack of padding after the images in the generated documentation, but that's very minor, I don't know how/if it can be solved.

Screen Shot 2021-11-19 at 12 32 20

@videlanicolas
Copy link
Copy Markdown
Contributor Author

Fixed, I added line separation between those images on my fork PR #3.

@videlanicolas
Copy link
Copy Markdown
Contributor Author

Adds to #41 .

@ephread
Copy link
Copy Markdown
Owner

ephread commented Nov 19, 2021

@videlanicolas thanks for fixing the spacing issue. I forgot to ask, what's in your .vscode for this project? I use VS Code too on a regular basis and if I don't mind committing a configuration file if it's something that would benefit everybody and enforce some much-needed conventions.

@videlanicolas
Copy link
Copy Markdown
Contributor Author

what's in your .vscode for this project?

I use a restructuredText extension, and that has some settings to auto-render the view while working. This is found under .vscode/settings.json. Given that not everybody has this extension, and that the only file under .vscode is this one, I figured we can ignore it since it doesn't break any build.

The contents:

{
    "restructuredtext.confPath": "${workspaceFolder}/docs/source",
    "restructuredtext.builtDocumentationPath": "${workspaceFolder}/docs/build"
}

@ephread
Copy link
Copy Markdown
Owner

ephread commented Nov 19, 2021

Alright, makes sense, thanks for the clarification. Merging now!

@ephread ephread merged commit 8b100d2 into ephread:main Nov 19, 2021
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.

2 participants