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

[FR] Update the pkgdown documentation #1158

Open
ArthurData opened this issue Jul 17, 2024 · 3 comments
Open

[FR] Update the pkgdown documentation #1158

ArthurData opened this issue Jul 17, 2024 · 3 comments
Assignees
Labels
enhancement New feature or request PR opened 👓
Milestone

Comments

@ArthurData
Copy link
Member

ArthurData commented Jul 17, 2024

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

  • Update the pkgdown
    • Rethink about articles
    • Add more content
  • Track view and traffic

Describe alternatives you've considered

  • Update vignettes name
@ArthurData ArthurData added the enhancement New feature or request label Jul 17, 2024
@ArthurData ArthurData self-assigned this Jul 17, 2024
@ArthurData
Copy link
Member Author

ArthurData commented Aug 5, 2024

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
Copy link
Member Author

ArthurData commented Aug 5, 2024

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
Copy link
Member Author

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

@ColinFay ColinFay added this to the Version 0.6.0 milestone Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request PR opened 👓
Projects
None yet
Development

No branches or pull requests

2 participants