ThinkR-open / golem

A Framework for Building Robust Shiny Apps
https://thinkr-open.github.io/golem/
Other
902 stars 132 forks source link

[FR] Update the pkgdown documentation #1158

Open ArthurData opened 1 month ago

ArthurData commented 1 month ago

Is your feature request related to a problem? Please describe. The pkgdown doesn't seem to be up to date.

── Building function reference ─────────────────────────────────────────────────
Error: 
! in callr subprocess.
Caused by error in `build_reference_index(pkg)`:
! All topics must be included in reference index
✖ Missing topics: golem_welcome_page and use_readme_rmd
ℹ Either add to _pkgdown.yml or use @keywords internal
ℹ See `$stderr` for standard error.

Describe the solution you'd like

Describe alternatives you've considered

ArthurData commented 1 month ago

The current state of the PR #1160 allows a "new" pkgdown to be built:

Screenshot 2024-08-05 at 16 11 15

Some changes have already been made.

These include

🎯 simplification of the README,

The separation of articles into several new sections:

🎯 A "Contribute" tab.

The article outlines how to contribute to the open-source Golem project on GitHub through reporting issues, contributing code and documentation, and sharing ideas, while also providing guidelines on the package's structure, code style, and conduct expectations for contributors.

🎯 A "Ressources" tab

The article provides a collection of resources related to the Golem package, including example apps created by ThinkR and the community, a recommended book on building production-grade Shiny apps, and a downloadable cheatsheet.

ArthurData commented 1 month ago

For the rest, I propose the creation of two new tabs:

🤔 A "getting started" tab

Inside, I'm proposing short, concise articles to cover the basics of golem.

These include:

📄 creating a golem application 📄 creating and using modules 📄 communication between modules 📄 using golem within a package: testing your code

🤔 An "Advanced" tab

Inside, several articles for advanced use of golem. These are articles to help you go further with golem: customising the appearance of your app, using routes, internationalising your app, etc...

These are articles that can be used as blog posts.

Here are the articles I have in mind:

📄 Customize your app with {bslib}

Screenshot 2024-08-05 at 16 28 41

📄 Use a maintenance page

Screenshot 2024-08-05 at 16 29 00

📄 Create routes with {brochure}

📄 Go faster with Hooks

📄 Deploy your app

📄 Internalization and translation

📄 Golem options (bookmarks, port, etc...)

📄 Insert and use static files (images, etc...)

ArthurData commented 1 month ago

Or maybe we can put all the documentation in golemverse.org ?