Skip to content

fix(spec): cleanup summary #451

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 12 commits into from
Apr 29, 2022
Merged

fix(spec): cleanup summary #451

merged 12 commits into from
Apr 29, 2022

Conversation

@bodinsamuel
Copy link
Contributor

@bodinsamuel bodinsamuel commented Apr 28, 2022 •
edited
Loading

🧭 What and Why

Clean up summary so that:

  • it does not ends with a . (better for sidebar display
  • it always fit in one line

Changes included:

  • Change Eslint rule to also enforce dot for summary
  • Transform documentation bundle so we can remove dot only for this bundle.
  • Fix some summary for conciseness
  • Bonus: Change primary color to be Algolia's one

🧪 Test

BUNDLE_WITH_DOC=true DOCKER=true yarn cli build specs search -s yarn website

Screenshot 2022-04-28 at 17 56 10
@bodinsamuel bodinsamuel self-assigned this Apr 28, 2022
@netlify
Copy link

netlify bot commented Apr 28, 2022 •
edited
Loading

✅ Deploy Preview for api-clients-automation canceled.

Name Link
🔨 Latest commit 744edc9
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/626c08307cb92900085679be
@algolia-bot
Copy link
Collaborator

algolia-bot commented Apr 28, 2022 •
edited
Loading

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
millotp
millotp reviewed Apr 28, 2022
View reviewed changes
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

Very cool thanks ! This could be a custom eslint rule 😜 , juste like descriptionDot.ts
shortcuts
shortcuts reviewed Apr 28, 2022
View reviewed changes
shortcuts
shortcuts reviewed Apr 28, 2022
View reviewed changes
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.

Thanks 💓
@bodinsamuel
Copy link
Contributor Author

https://deploy-preview-451--api-clients-automation.netlify.app/
@bodinsamuel
Copy link
Contributor Author

not sure why the cts fail
@millotp
Copy link
Collaborator

millotp commented Apr 29, 2022

I'll let you guess, it's been a recurring issue 😭
@millotp
Copy link
Collaborator

millotp commented Apr 29, 2022 •
edited
Loading

you can try to bump the cache key by hand in .github/.cache_version to clean the cache
shortcuts
shortcuts reviewed Apr 29, 2022
View reviewed changes
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.

N I C E
shortcuts
shortcuts reviewed Apr 29, 2022
View reviewed changes
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.

Nothing else to say :D nice changes
shortcuts
shortcuts previously approved these changes Apr 29, 2022
View reviewed changes
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.

thanks!
website/docs/api-clients/migration-guide.mdx
</Tabs>

### Methods targetting an `indexName`
### Methods targeting an `indexName`
Copy link
Member

Choose a reason for hiding this comment

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

oopsie 😊
shortcuts
shortcuts previously approved these changes Apr 29, 2022
View reviewed changes
@bodinsamuel
Copy link
Contributor Author

CTS still failing, maybe I have broken something :(
@millotp millotp mentioned this pull request Apr 29, 2022
Merged
@millotp @shortcuts
chore(ci): make the cache not depends on generated files (#458)
5cc00af 
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
@millotp
Copy link
Collaborator

millotp commented Apr 29, 2022

oops I didn't mean to merge on this PR, hope it won't break
@millotp
Copy link
Collaborator

millotp commented Apr 29, 2022

I'm fixing the conflict
shortcuts
shortcuts approved these changes Apr 29, 2022
View reviewed changes
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.

:blob-flying: looks good!!
@bodinsamuel
Copy link
Contributor Author

Still can't merge so when you want 😬
thanks for the reviews <3
@shortcuts shortcuts enabled auto-merge (squash) April 29, 2022 15:18
@millotp
Copy link
Collaborator

millotp commented Apr 29, 2022

Just one last fix I promise (i'm gonna die)
@shortcuts shortcuts merged commit 8990cac into main Apr 29, 2022
@shortcuts shortcuts deleted the fix/search-spec-cleanup branch April 29, 2022 15:56
This was referenced May 19, 2022
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

4 participants

@bodinsamuel @algolia-bot @millotp @shortcuts