Move Success stories to website

[HalfWhitt]

What is the problem or limitation you are having?

I started to proofread the success stories, then I thought... Why not reformat this to make it more consistent and informative?

Describe the solution you'd like

I'm envisioning a table, listing the same info for each app:

• Name (which links to the app, as currently)
• Perhaps a small screenshot
• Brief description of what it does
• Platform(s) supported

Also, we currently have one page for Briefcase and one for Toga; they have some apps in common and some unique, and there's no mechanism to sync these. Considering how often people ask about examples, I think it might make more sense to put one combined page on the main site, and potentially link to it from both docs. It would also then make sense, I imagine, to add a column for "BeeWare component(s) used".

Describe alternatives you've considered

We could still maintain separate pages, but I'm not sure if there's a good way to make sure they stay in sync with each other. It's also not clear, currently, from just looking at one, which of the apps also use the other.

If we do keep the individual pages, it seems redundant to mention that each app uses the tech in question.

Additional context

No response

[mhsmith]

Yes, that all sounds good.

[Odzen]

https://toga.readthedocs.io/en/stable/about/success.html

I think this is the correct link.

[HalfWhitt]

https://toga.readthedocs.io/en/stable/about/success.html

I think this is the correct link.

Ah, yes, thank you. Things were recently reorganized, I guess that was one that moved. I've edited the initial post.

[Pulga8]

Hi! Maybe i can take this? I have a couple of questions before i start:

1. I dont understand if i have to add the success stories in the 'About' of BeeWare or only refactor the success stories in the 'About' of Toga?
2. How should images be added? I read the PR "Reformat Success Stories#3645" but at that time the docs were in '.srt' not '.md'. One proposed solution by frakboy was to use a " lightbox popup in pure CSS." However im steel unsure about how to add images correctly.

Tks in advance!

[HalfWhitt]

Hi! Maybe i can take this?

Sure, you're welcome to take a stab at it! Check out our contribution guide for details on how to set up your environment, build the documentation locally, and submit a pull request.

1. I dont understand if i have to add the success stories in the 'About' of BeeWare or only refactor the success stories in the 'About' of Toga?

I think that ultimately, it would be a good idea to put it in one central location. That said, making Toga's existing list more presentable would be a great improvement for now, and could later be used as a template for a version on the main site.

2. How should images be added? I read the PR "Reformat Success Stories#3645" but at that time the docs were in '.srt' not '.md'. One proposed solution by frakboy was to use a " lightbox popup in pure CSS." However im steel unsure about how to add images correctly.

In terms of design intent, I think the best user experience is indeed probably a lightbox-style approach, with the table containing only small thumbnails, which can then be expanded to see the full-size images. I'm not opposed to other approaches, if you hit upon something that looks good and is usable.

As for the implementation, the file extension change you're seeing is because we've moved our entire docs ecosystem from using reStructuredText to Markdown. Markdown natively supports images, but that alone probably isn't ideal here. It seems there a number of ways to add lightbox functionality to Markdown; a cursory search brings up MkDocs GLightBox, though I've not tried it and can't vouch for its functionality.

Adding an MkDocs plugin involves adding a dependency under docs in Toga's top-level pyproject.toml (e.g. mkdocs-redirects==1.2.2), then adding it under plugins in docs/config.yml (e.g. redirects:; the name to use is specified in the specific plugin's documentation).

Does that all make sense so far? Feel free to ask questions as they come up.

[kattni]

Toga has been updated in beeware/toga#4256. I am leaving this open as we need to move all success stories to beeware.org/about/ in the same format as they are on Toga.

[kattni]

Transferring this issue from Toga, as the Toga piece is completed.