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

docs: Add faq page on changing font size 📚 #80

Merged
merged 7 commits into from
Sep 24, 2023
Merged

docs: Add faq page on changing font size 📚 #80

merged 7 commits into from
Sep 24, 2023

Conversation

kdheepak
Copy link
Contributor

No description provided.

@kdheepak kdheepak requested a review from joshka September 20, 2023 03:23
@github-actions
Copy link

github-actions bot commented Sep 20, 2023

PR Preview Action v1.4.4
Preview removed because the pull request was closed.
2023-09-24 13:47 UTC

@joshka
Copy link
Member

joshka commented Sep 20, 2023

If we keep adding pages, the FAQ section will be large. I mainly put the duplicate key in the TOC because it's so common (~weekly)

@kdheepak kdheepak force-pushed the add-faq branch 2 times, most recently from 4c18d80 to 93d8bd3 Compare September 20, 2023 03:34
@kdheepak
Copy link
Contributor Author

I don't see a huge downside to having a big TOC. I think of it as the one stop shop to find what is in the book. Open to suggestions though. I tried removing from Summary.md and adding them to ./src/faq/README.md but I get link check errors:

image

@kdheepak
Copy link
Contributor Author

I guess you meant it should not be in faq and be somewhere else? I moved it to how-to/develop-apps. Let me know what you think?

@joshka
Copy link
Member

joshka commented Sep 20, 2023

I meant more having a single main FAQ page, but that Key Press issue is frequent enough to call it out specifically

@kdheepak
Copy link
Contributor Author

That one page is going to be pretty long then no? I can see it being useful for multiple shorter FAQs though

@joshka
Copy link
Member

joshka commented Sep 20, 2023

That one page is going to be pretty long then no? I can see it being useful for multiple shorter FAQs though

Yes, it allows for longer question names though and not having to think about making everything into something that's worth a title.

@kdheepak
Copy link
Contributor Author

I'm going to merge this. Let's discuss TOC organization in a future PR.

@kdheepak kdheepak merged commit 4e90cf5 into main Sep 24, 2023
2 checks passed
@kdheepak kdheepak deleted the add-faq branch September 24, 2023 13:46
@joshka joshka mentioned this pull request Jun 4, 2024
joshka pushed a commit that referenced this pull request Jun 4, 2024
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