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

Updated the FAQ and changed some of the formatting. #33

Merged
merged 1 commit into from
Sep 9, 2021

Conversation

jacobsky
Copy link
Contributor

@jacobsky jacobsky commented Sep 6, 2021

@Bromeon As I mentioned via discord, I went through the issues and extrapolated on cleaned up the FAQ a bit.
Also added a fix to have the logging recipe get added to the summary as it was previously missing.

Copy link
Member

@Bromeon Bromeon left a comment

Choose a reason for hiding this comment

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

Thank you very much, your changes add some extremely valuable insights 👍🏼

I tried to be quite open about my thoughts, so expect lots of comments 🙂

In cases where I added code or text, it can make sense if you use the "Quote comment" function to get the original formatting -- this is especially true for links within this repo, which are sugared by GitHub. Also feel free to copy-paste anything verbatim.

Some general consistency remarks: maybe check the capitalization of a few keywords -- Rust, Godot, godot-rust, GDNative, GDScript. At some point in the distant future I might add CI checks for those 😛

src/faq/code-faq.md Outdated Show resolved Hide resolved
src/faq/code-faq.md Outdated Show resolved Hide resolved
src/faq/code-faq.md Outdated Show resolved Hide resolved
src/faq/code-faq.md Outdated Show resolved Hide resolved
src/faq/code-faq.md Outdated Show resolved Hide resolved
src/faq/multithreading-faq.md Outdated Show resolved Hide resolved
src/faq/tooling-faq.md Outdated Show resolved Hide resolved
src/faq/tooling-faq.md Outdated Show resolved Hide resolved
src/faq/tooling-faq.md Outdated Show resolved Hide resolved
src/faq/tooling-faq.md Outdated Show resolved Hide resolved
@jacobsky
Copy link
Contributor Author

jacobsky commented Sep 7, 2021

@Bromeon Thank you for all the valuable insight. I've gone ahead and incorporated your changes. I appreciate the thorough look into the full FAQ. If you have any additional changes, please feel free to let me know.

@jacobsky jacobsky force-pushed the faq-from-issues branch 3 times, most recently from 490b7f3 to 58a811a Compare September 7, 2021 12:41
@jacobsky
Copy link
Contributor Author

jacobsky commented Sep 7, 2021

@Bromeon Alrighty. I think the most recent push should resolve the last of the changes. Please let me know if there's anything else that needs doing :)

@jacobsky
Copy link
Contributor Author

jacobsky commented Sep 7, 2021

Also I just noticed, but I believe this resolves issue #23 and possibly #5

@Bromeon
Copy link
Member

Bromeon commented Sep 7, 2021

It also overlaps somewhat with godot-rust/book#24.
That would be 4-in-1, do you think we'll manage 5? 😬

@jacobsky
Copy link
Contributor Author

jacobsky commented Sep 7, 2021

@Bromeon To ensure that we can close #5 I went ahead and added a section on profiling to "code-faq.md" at the bottom. I'm starting to think that I'll need to work on another PR to make some sub-sections for "code-faq" since it's getting pretty long and a little mixed up/hard to follow.

Copy link
Member

@Bromeon Bromeon left a comment

Choose a reason for hiding this comment

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

I agree, this PR is already big enough, we can always add more and refine things in the future 🙂

src/SUMMARY.md Outdated Show resolved Hide resolved
src/faq/code-faq.md Outdated Show resolved Hide resolved
src/faq/code-faq.md Outdated Show resolved Hide resolved
src/faq/code-faq.md Outdated Show resolved Hide resolved
src/faq/code-faq.md Outdated Show resolved Hide resolved
src/faq/code-faq.md Outdated Show resolved Hide resolved
src/faq/code-faq.md Outdated Show resolved Hide resolved
src/faq/tooling-faq.md Outdated Show resolved Hide resolved
src/faq/tooling-faq.md Outdated Show resolved Hide resolved
src/faq/tooling-faq.md Outdated Show resolved Hide resolved
Added an additional Q/A that I missed that would probably be useful.

Added profiling FAQ to close godot-rust#5

Also added a fix to have the logging recipe get added to the summary as it was previously missing.
@Bromeon
Copy link
Member

Bromeon commented Sep 9, 2021

Thanks a lot for this huge contribution! Will definitely help a lot of newcomers to navigate 🙂

@Bromeon Bromeon merged commit 2bfa40c into godot-rust:master Sep 9, 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.

Mention how to create gdnlib and gdns files Frequently asked questions
2 participants