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

fix(spec): add more tags #464

Merged
merged 4 commits into from
May 6, 2022
Merged

fix(spec): add more tags #464

merged 4 commits into from
May 6, 2022

Conversation

bodinsamuel
Copy link
Contributor

@bodinsamuel bodinsamuel commented Apr 29, 2022

🧭 What and Why

Changes included:

For abtesting, analytics, insights

  • Add tags
  • Update summary with what is currently wrote in /doc

Update Docusaurus

  • Rename tab in the navbar to clarify page and move contributing guide outside of the main nav (open to debate)
  • Hide star banner that breaks my scroll in API pages
  • Capitalize client name since it's hard to do in pure js

🧪 Test

BUNDLE_WITH_DOC=true DOCKER=true yarn cli build specs all

yarn website

Screenshot 2022-04-29 at 19 51 43

@bodinsamuel bodinsamuel self-assigned this Apr 29, 2022
@algolia-bot
Copy link
Collaborator

algolia-bot commented Apr 29, 2022

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.

@netlify
Copy link

netlify bot commented Apr 29, 2022

Deploy Preview for api-clients-automation failed.

Name Link
🔨 Latest commit 186253d
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/6274d294c8ffbc0008a8f39e

Copy link
Contributor

@damcou damcou left a comment

Choose a reason for hiding this comment

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

Very nice ! It looks clearer like this :)

Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

Small comment, looks really nice otherwise, thanks :D

@@ -104,7 +106,7 @@ function getSpecsForNavBar() {
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
navbar: {
title: 'API Clients Automation',
title: 'Algolia API',
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
title: 'Algolia API',
title: 'Algolia API Clients',

This project/documentation is more than just the API, I'd at least keep the Clients keyword

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 resolved and merged meaning you have changed your mind? :D

Copy link
Member

Choose a reason for hiding this comment

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

Yup actually most of the websites groups API and API clients under the API name... so you are right :D

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.

4 participants