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

Adds 'Frequently Asked Questions' page #81

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from

Conversation

Natolida
Copy link
Contributor

@Natolida Natolida commented Oct 9, 2024

  • Adds FAQ.md to 'Resouces' folder
  • Updates 'Index.md' to include

Adds FAQ page to resources
Adds "Frequently Asked Questions" to Resources Index
Adds 'Frequently Asked Questions' page
- Adds FAQ.md to resources folder
- Updates Index.md to include 'Frequently Asked Questions'
@Natolida
Copy link
Contributor Author

Natolida commented Oct 9, 2024

Hey Team,

I think the FAQs page is at a good enough point to add to the docs, and we can continue to build from there. Would you mind reviewing the validity of the information? This is my first significant contribution, and I would hate for any information to be inaccurate.

Cheers,
David

Copy link
Contributor

@ebouchut ebouchut left a comment

Choose a reason for hiding this comment

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

I found a couple of typos (✏️).
I also suggest using Markdown headings for FAQ articles to improve their searchability and navigability.

Thank you @Natolida, as a new Trio user, I found this page useful.

docs/EN/resources/FAQ.md Outdated Show resolved Hide resolved
docs/EN/resources/FAQ.md Outdated Show resolved Hide resolved
docs/EN/resources/FAQ.md Outdated Show resolved Hide resolved
docs/EN/resources/FAQ.md Outdated Show resolved Hide resolved
docs/EN/resources/FAQ.md Show resolved Hide resolved
docs/EN/resources/FAQ.md Outdated Show resolved Hide resolved
- Corrects typo's
- Removes erroneous wording
- Adds markdown headings to questions
- Limits used of <br> instead using double space
@Natolida
Copy link
Contributor Author

Natolida commented Oct 9, 2024

Thanks @ebouchut, I appreciate your feedback! All suggested changes have been applied.

Copy link
Contributor

@ebouchut ebouchut left a comment

Choose a reason for hiding this comment

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

I found one typo, otherwise 👍 LGTM regarding the structure.

docs/EN/resources/FAQ.md Outdated Show resolved Hide resolved
- Fixes typo
- Name change from John to Bill in examples for continuity through docs.
@Natolida
Copy link
Contributor Author

Hey @tmhastings, I am wondering if it would be a good idea to get this in prior to the docs migration?

Copy link
Contributor

@tmhastings tmhastings left a comment

Choose a reason for hiding this comment

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

Left a few comments on places that need some minor edits. Once fixed, I'm ready to approve. Thank you for putting this together. It looks great!

docs/EN/resources/FAQ.md Outdated Show resolved Hide resolved
docs/EN/resources/FAQ.md Outdated Show resolved Hide resolved
docs/EN/resources/FAQ.md Outdated Show resolved Hide resolved
docs/EN/resources/FAQ.md Show resolved Hide resolved
- Fixes Typo
- Adopts suggested changes as per T. Hastings
@Natolida
Copy link
Contributor Author

Thanks team, all updated and should be ready to go.

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.

3 participants