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: improve versiondropdown design & set docs main to /features #9994

Merged
merged 9 commits into from
Mar 15, 2024

Conversation

yoonhyejin
Copy link
Collaborator

@yoonhyejin yoonhyejin commented Mar 6, 2024

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)

  • Links to related issues (if applicable)

  • Tests for the changes have been added/updated (if applicable)

  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.

  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

  • set docs main page to /features (in the old versions as well)

  • add "archived versions" and hr to version dropdown
    image

@yoonhyejin yoonhyejin requested a review from hsheth2 March 6, 2024 06:54
@yoonhyejin yoonhyejin changed the title feat: improve dropdown design & set docs main to /features docs: improve versiondropdown design & set docs main to /features Mar 6, 2024
value: '<div style="font-size:0.875rem; padding: 0.25rem 0.5rem;"><b>Archived versions</b></div>',
},
{
href: "https://docs-website-irpoe2osc-acryldata.vercel.app/docs/features",
label: "0.11.0",
Copy link
Collaborator

Choose a reason for hiding this comment

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

not strictly necessary, but we add a little external link icon
image

@@ -45,7 +45,7 @@ module.exports = {
},
items: [
{
to: "docs/",
to: "docs/features",
Copy link
Collaborator

Choose a reason for hiding this comment

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

there's a number of other pages where we link to the main docs/ page

it'd be easier to remove the existing page, and change the slug for "docs/features" to be "docs/"

however, I think we need to give the docs/features page a slight UI uplift before elevating it - it just looks slightly less crisp than the current docs/ main page

@yoonhyejin yoonhyejin enabled auto-merge (squash) March 15, 2024 08:00
@yoonhyejin yoonhyejin disabled auto-merge March 15, 2024 08:00
@yoonhyejin yoonhyejin merged commit 3f85896 into master Mar 15, 2024
34 checks passed
@yoonhyejin yoonhyejin deleted the docs/docs-landing-page branch March 15, 2024 08:43
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