Skip to content

Move Briefcase to MkDocs#2502

Merged
freakboy3742 merged 36 commits intobeeware:mainfrom
kattni:tooling/mkdocs
Oct 24, 2025
Merged

Move Briefcase to MkDocs#2502
freakboy3742 merged 36 commits intobeeware:mainfrom
kattni:tooling/mkdocs

Conversation

@kattni
Copy link
Contributor

@kattni kattni commented Oct 8, 2025

Getting this going for testing purposes.

Fixes #2387

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

@kattni kattni marked this pull request as draft October 8, 2025 02:07
@kattni kattni changed the title WIP: Move Briefcase to MkDocs Move Briefcase to MkDocs Oct 9, 2025
@kattni kattni marked this pull request as ready for review October 9, 2025 08:50
@kattni
Copy link
Contributor Author

kattni commented Oct 10, 2025

@freakboy3742 This is ready for review.

Notes:

  • Please review the content on the various index pages, as it's primarily new content produced by me, and you may have Thoughts.

@kattni kattni requested a review from freakboy3742 October 10, 2025 06:13
Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

tl;dr - this looks great, and is really close to being mergable; as with Toga, I'd rather merge this early and fix any minor issues that are found rather than try to keep it up to date while we get it perfect.

I've cleaned up a handful of things that I noticed that were easy cleanups; some bigger issues:

  • Newline reflow - Toga converged on using line breaks only for paragraphs; that hasn't been applied here.
  • iOS Permissions - 2nd level bullet points aren't being interpreted as indented
  • Android icon formats - same bullet point issues
  • The "Community details" page is still in the left-hand index (and exists as a page), but is duplicate on the homepage.

The only other thing that I noticed was the "hand crafted" table format. I understand why that's been done, and I can live with merging as is. However, it's worth flagging as follow up work that the work @HalfWhitt has done in the Toga docs to clean up tables could be used here as well.

@kattni
Copy link
Contributor Author

kattni commented Oct 23, 2025

The tables are terrible, yes. I agree the Toga updates would be useful here.

Everything else should be good to go.

Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

Looks good to me!

Marking as accepted. Given the size of the change, I'd like @mhsmith to sign off as well before merging; but I think the same approach makes sense here as did with Toga - it's better to merge somethign on latest that has some known issues and resolve those piecemeal, rather than try to maintain this as a branch until we know it's perfect.

@freakboy3742 freakboy3742 requested a review from mhsmith October 23, 2025 07:06
@kattni kattni requested a review from mhsmith October 23, 2025 19:32
@mhsmith
Copy link
Member

mhsmith commented Oct 23, 2025

Thanks, that all looks good, but unfortunately there's one last conflict from #2496 that will need to be resolved.

@freakboy3742
Copy link
Member

Thanks, that all looks good, but unfortunately there's one last conflict from #2496 that will need to be resolved.

I've just merged and fixed that one.

Copy link
Member

@mhsmith mhsmith left a comment

Choose a reason for hiding this comment

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

OK, I'm finished for the day now, but consider it approved once the build works and the post-install docs render correctly.

Well done!

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.

Switch to using dependency groups for dev/docs/test dependencies

3 participants