Skip to content

docs: use pkgdown BS5#70

Merged
krlmlr merged 7 commits intoduckdb:mainfrom
maelle:pkgdown
Feb 9, 2024
Merged

docs: use pkgdown BS5#70
krlmlr merged 7 commits intoduckdb:mainfrom
maelle:pkgdown

Conversation

@maelle
Copy link
Contributor

@maelle maelle commented Feb 8, 2024

Fix #31

  • BS5
  • low-hanging fruits: adding authors' URLs
  • ignoring docs/
  • making the duckdb-package manual page internal, as it brings nothing to the reference index.

I need to build the website locally to check things, then this will be ready for review.

@maelle
Copy link
Contributor Author

maelle commented Feb 8, 2024

This looks mostly good, apart from the giant logo. @krlmlr would it be worth for me to explore how to make the logo a PNG so it's not as huge in the pkgdown website?

@maelle maelle marked this pull request as ready for review February 8, 2024 15:50
@krlmlr
Copy link
Collaborator

krlmlr commented Feb 8, 2024

Please do. Thanks!

href: "http://hannes.muehleisen.org/"
Mark Raasveldt:
href: "https://mytherin.github.io/"

Copy link
Collaborator

Choose a reason for hiding this comment

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

Add https://krlmlr.info/ for myself too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You are not listed as an author (yet?)!

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c3184e8) 85.95% compared to head (84b7f52) 85.89%.

❗ Current head 84b7f52 differs from pull request most recent head 12af9c3. Consider uploading reports for the commit 12af9c3 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #70      +/-   ##
==========================================
- Coverage   85.95%   85.89%   -0.06%     
==========================================
  Files         106      106              
  Lines        3602     3602              
==========================================
- Hits         3096     3094       -2     
- Misses        506      508       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Co-authored-by: Kirill Müller <krlmlr@users.noreply.github.com>
@maelle
Copy link
Contributor Author

maelle commented Feb 9, 2024

So nice that there's a FAQ item on the logo http://duckdb.org/faq#where-do-i-find-the-duckdb-logo 👌

For the favicons, the logo itself would look bad so I'm using the favicon files from https://github.com/duckdb/duckdb-web/tree/main/images/favicon

@maelle
Copy link
Contributor Author

maelle commented Feb 9, 2024

image

image

@maelle maelle requested a review from krlmlr February 9, 2024 07:49
@maelle
Copy link
Contributor Author

maelle commented Feb 9, 2024

@krlmlr I ran document() to make the logo appear on the package-level manual page, which is how I realized it was created manually and with the deprecated docType, so I updated that as well. Created this way, the package-level manual page is itnernal so pkgdown won't add it in the index. This PR is now really ready.

@krlmlr krlmlr merged commit a487572 into duckdb:main Feb 9, 2024
@krlmlr
Copy link
Collaborator

krlmlr commented Feb 9, 2024

Thanks!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 9, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

pkgdown website?

3 participants