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

Add sections into function reference page of pkgdown site #58

Open
matt-dray opened this issue May 1, 2024 · 1 comment
Open

Add sections into function reference page of pkgdown site #58

matt-dray opened this issue May 1, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation must do v1 Need resolving for first release question Further information is requested
Milestone

Comments

@matt-dray
Copy link
Collaborator

matt-dray commented May 1, 2024

The function reference page lists all the functions, which can be clicked to see a rendering of the help files.

These can be grouped into sections with short preambles to make it easier for users to understand the intent of the functions. See the example for {dplyr}'s site, for example. These groups can be declared in _pkgdown.yml.

Provide headings for (1) wl_* functions, (2) simulation, (3) 'building block' functions, etc. What should these groupings be?

Makes sense to wait for the function names to be confirmed before doing this.

@ThomUK ThomUK added this to the v0.1 milestone May 1, 2024
@matt-dray matt-dray self-assigned this May 1, 2024
@matt-dray matt-dray added documentation Improvements or additions to documentation question Further information is requested labels May 1, 2024
@chrismainey
Copy link
Collaborator

Might not be necessary now given functions are prefixed by type.

@chrismainey chrismainey added the must do v1 Need resolving for first release label Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation must do v1 Need resolving for first release question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants