Skip to content

Move the Textual FAQ into the main docs #3129

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Aug 21, 2023
Merged

Move the Textual FAQ into the main docs #3129

merged 2 commits into from
Aug 21, 2023

Conversation

@davep
Copy link
Contributor

@davep davep commented Aug 21, 2023

Implements #3068.

@davep davep linked an issue Aug 21, 2023 that may be closed by this pull request
Move the FAQ in to the docs #3068
Closed
@davep davep self-assigned this Aug 21, 2023
@davep davep added documentation Improvements or additions to documentation Task labels Aug 21, 2023
rodrigogiraoserrao
rodrigogiraoserrao reviewed Aug 21, 2023
View reviewed changes
Copy link
Contributor

@rodrigogiraoserrao rodrigogiraoserrao left a comment

Choose a reason for hiding this comment

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

Don't we need to add faqtory to the (dev) dependencies of Textual, then?

@davep
Copy link
Contributor Author

davep commented Aug 21, 2023

Good call; I had thought it was.

@davep
Drop the automatic generation of the FAQ (for now)
a9de513 
For this to work faqtory needs to be a development dependency of Textual.
Textual still maintains support for Python 3.7; faqtory is Python 3.8 or
greater. So, for the moment, we're going to cheat a little and make it so
that you have to remember to run faqtory to rebuild FAQ.md.

All hail the walrus!
willmcgugan
willmcgugan approved these changes Aug 21, 2023
View reviewed changes
Copy link
Member

@willmcgugan willmcgugan left a comment

Choose a reason for hiding this comment

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

Nice

@davep davep merged commit 061a88d into Textualize:main Aug 21, 2023
@davep davep deleted the faq-in-docs branch August 21, 2023 20:16
@davep
Copy link
Contributor Author

davep commented Aug 21, 2023

I just realised something: rather than have the two different link IDs floating around, I dropped faqtory's slugs from the generated FAQ and leaned into mkdocs-materials' IDs generated from the headers; but now I think about it faqtory and mkdocs-material might not slug the same.

I'll make an issue to double-check this tomorrow and I might have to add the faqtory slugs back and we'll just accept the duplication of effort in the page.

@davep davep mentioned this pull request Aug 21, 2023
Closed
@willmcgugan
Copy link
Member

Good point!

@willmcgugan
Copy link
Member

I'm open to modifying the slug generation in FAQtory to match.

@davep davep mentioned this pull request Aug 26, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@willmcgugan willmcgugan willmcgugan approved these changes

@darrenburns darrenburns Awaiting requested review from darrenburns

@rodrigogiraoserrao rodrigogiraoserrao Awaiting requested review from rodrigogiraoserrao

Assignees

@davep davep

Labels

documentation Improvements or additions to documentation Task

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Move the FAQ in to the docs

3 participants

@davep @willmcgugan @rodrigogiraoserrao