Skip to content

docs: add basic homepage and WIP banner #815

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

Merged
merged 2 commits into from
Jul 12, 2022
Merged

Conversation

shortcuts
Copy link
Member

🧭 What and Why

🎟 JIRA Ticket:

Changes included:

The goal of this PR is to provide a less WIP looking documentation, with some redirections to the Algolia documentation.

Homepage

Adds a basic homepage that can be iterated on, we should add some additional information (like on https://docsearch.algolia.com/).

(GH stars button points to DocSearch, as this repository is not public yet)

light dark
Screenshot 2022-07-12 at 13 58 54 Screenshot 2022-07-12 at 13 59 05

WIP banner

  • Adds a small banner at the top of every page to state
  • Mention migration guide in the homepage
light dark
Screenshot 2022-07-12 at 14 03 31 Screenshot 2022-07-12 at 14 03 49

Other changes

  • Use other themes for codeblocks
  • Add link to the Algolia documentation in navbar (might be too much since we have the banner, wdyt?)
  • Styles: I've imported the fragment stylesheet (from the DocSearch repository) as I did not found a published one, lmk if you know 🤔

🧪 Test

Netlify preview

@shortcuts shortcuts self-assigned this Jul 12, 2022
@netlify
Copy link

netlify bot commented Jul 12, 2022

Deploy Preview for api-clients-automation ready!

Name Link
🔨 Latest commit 67aa704
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/62cd7c1af36b120008269474
😎 Deploy Preview https://deploy-preview-815--api-clients-automation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@algolia-bot
Copy link
Collaborator

algolia-bot commented Jul 12, 2022

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

millotp
millotp previously approved these changes Jul 12, 2022
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.

I couldn't find a CDN for the css file 🤷
The home page looks really good ! I think it's okay to have duplicate link to the doc, at least it's easy to find

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.

This looks very nice indeed 🤩 .
Maybe the hover style of the contribute button could be more readable but I'm pinnailling.

@shortcuts
Copy link
Member Author

This looks very nice indeed 🤩 . Maybe the hover style of the contribute button could be more readable but I'm pinnailling.

I did not applied extra styling to it, it seems to be the default rendering 🤔

@shortcuts shortcuts merged commit 042b5a5 into main Jul 12, 2022
@shortcuts shortcuts deleted the docs/homepage-and-wip-notice branch July 12, 2022 14:27
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Jul 12, 2022
medicindev pushed a commit to medicindev/Algolia-Client--JavaScript that referenced this pull request Mar 8, 2025
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