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

Docs #59

Merged
merged 87 commits into from
Nov 14, 2019
Merged

Docs #59

merged 87 commits into from
Nov 14, 2019

Conversation

maelle
Copy link
Member

@maelle maelle commented Oct 29, 2019

cf #58, here's what I suggest

  • Make README shorter, put search details into a vignette.
  • Re-work pkgdown navbar and reference.
  • Add extra.css otherwise the table of contents of the search vignette looks bad

In the local installed version users would see the package level docs, the vignette about search, and for other features I think the function index is enough (so no need to reproduce the README content as a vignette?)

@maelle maelle requested a review from gaborcsardi October 29, 2019 11:45
@maelle maelle mentioned this pull request Oct 31, 2019
Copy link
Contributor

@gaborcsardi gaborcsardi left a comment

Choose a reason for hiding this comment

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

Thanks! Left some comments.

README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
@maelle
Copy link
Member Author

maelle commented Nov 12, 2019

The mp4 to gif conversion went wrong 🤔

@maelle
Copy link
Member Author

maelle commented Nov 12, 2019

Not sure what to think of the LaTeX travis failure.

@maelle
Copy link
Member Author

maelle commented Nov 12, 2019

The GIF is much too big atm

@gaborcsardi gaborcsardi merged commit 8ef39cc into master Nov 14, 2019
@gaborcsardi gaborcsardi deleted the readme branch November 14, 2019 10:16
@gaborcsardi gaborcsardi mentioned this pull request Nov 14, 2019
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.

2 participants