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

Add the beginnings of an FAQ #1684

Merged
merged 3 commits into from
Apr 14, 2022
Merged

Add the beginnings of an FAQ #1684

merged 3 commits into from
Apr 14, 2022

Conversation

rylev
Copy link
Contributor

@rylev rylev commented Apr 12, 2022

Addresses #1647

I didn't have quite the time to finish it, but this is at least the beginnings of an FAQ. Feel free to hold off another day or two, and I will have these questions answered. Otherwise, feel free to merge, and I'll do a follow-up PR.

I decided for a markdown file for the following reasons:

  • it's the easiest to collaborate on (editing issues can get messy fast and GitHub wikis don't allow for contribution from others)
  • it's pretty straightforward to find
  • If running automated tests on code blocks ever becomes a necessity, this will be easiest to do in a markdown file (there is already some tooling for this).

We can see how easily we're able to maintain this and make adjustments accordingly.

@rylev rylev requested a review from kennykerr April 12, 2022 16:58
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@riverar riverar left a comment

Choose a reason for hiding this comment

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

Edited for grammar/style, nothing major. Look forward to reading the rest, thanks Ryan!

docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
Co-authored-by: Ryan Levick <me@ryanlevick.com>
Co-authored-by: Rafael Rivera <rafael@withinwindows.com>
@@ -8,6 +8,7 @@ The `windows` crate lets you call any Windows API past, present, and future usin
* Crate documentation
* [windows](https://microsoft.github.io/windows-docs-rs/)
* [windows-sys](https://docs.rs/windows-sys)
* [Frequently Asked Questions](../docs/FAQ.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Since this shows up on crates.io I think we need to use the full path as the Samples link below demonstrates.

.github/readme.md Outdated Show resolved Hide resolved
@kennykerr kennykerr merged commit 2db1d34 into microsoft:master Apr 14, 2022
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.

4 participants