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

Explain documentation structure #290

Merged
merged 2 commits into from
Jun 14, 2022
Merged

Conversation

kamilzyla
Copy link
Collaborator

Changes

Closes #240.

How to test

Run pkgdown::build_home() and review the changes.

Copy link
Member

@jakubnowicki jakubnowicki 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

Rhino is distributed under [LGPL-3.0 license]. Developed with :heart: at [Appsilon].
1. [**Tutorial**](https://appsilon.github.io/rhino/articles/tutorial/create-your-first-rhino-app.html):
Start here to learn the basics.
2. **Explanation**:
Copy link
Member

Choose a reason for hiding this comment

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

It would be great if all section titles here were clickable (e.g. go to the top of the page and open the section dropdown).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I thought about that too 😉 It's challenging though, as this README is also displayed on GitHub. Would require some JS magic probably. I'll skip on this for now.

@kamilzyla kamilzyla merged commit 6e64fb9 into main Jun 14, 2022
@kamilzyla kamilzyla deleted the explain-documentation-structure branch June 14, 2022 11:19
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.

Explain how documentation is structured
2 participants