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: add K3ai to showcase #6952

Merged
merged 11 commits into from
Mar 21, 2022
Merged

docs: add K3ai to showcase #6952

merged 11 commits into from
Mar 21, 2022

Conversation

alefesta
Copy link
Contributor

Motivation

I'd like to showcase k3ai (https://k3ai.in) an opensource tool made to simplify the life of AI practitioners when it comes to learning and experimenting.
I've followed the docs accordingly to submit this PR.

Have you read the Contributing Guidelines on pull requests?

yes I did

@facebook-github-bot
Copy link
Contributor

Hi @alefesta!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@Josh-Cena Josh-Cena changed the title Add K3ai website to the showcase section docs: add K3ai to showcase Mar 21, 2022
@Josh-Cena Josh-Cena added the pr: documentation This PR works on the website or other text documents in the repo. label Mar 21, 2022
@Josh-Cena
Copy link
Collaborator

Josh-Cena commented Mar 21, 2022

Thanks. Just so that you know, your initial submission:

  • contained duplicate entries.
  • contained syntax errors.
  • self-assigned the "favorite" tag, which we have stated in the comment that you should not.

I have fixed those for you.

In addition, w.r.t. your website:

  • https://k3ai.github.io/docs/command-reference/k3ai this page abuses the <details> element and leads to undesirable UX. People who want to look for information about a command have to browse through all the dropdowns, clicking on them one-by-one. Also, the <summary>, per the HTML spec, should only contain inline elements, so putting headings here is inappropriate. You'd rather want to use separate doc pages instead. Remember, there's no tax on the Internet for taking extra space!
  • Your primary color is inaccessible in light mode. You can follow our guide to create an accessible website: https://docusaurus.io/docs/styling-layout#styling-your-site-with-infima

@netlify
Copy link

netlify bot commented Mar 21, 2022

✅ [V2]
Built without sensitive environment variables

🔨 Explore the source changes: 931757a

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/6238925e78d07300091d30b5

😎 Browse the preview: https://deploy-preview-6952--docusaurus-2.netlify.app

@github-actions
Copy link

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 73
🟢 Accessibility 100
🟢 Best practices 92
🟢 SEO 100
🟢 PWA 90

Lighthouse ran on https://deploy-preview-6952--docusaurus-2.netlify.app/

@alefesta
Copy link
Contributor Author

Thanks. Just so that you know, your initial submission:

  • contained duplicate entries.
  • contained syntax errors.
  • self-assigned the "favorite" tag, which we have stated in the comment that you should not.

I have fixed those for you.

Tthanks a lot .. sorry about the "favorite" thing was unintentional

In addition, w.r.t. your website:

  • https://k3ai.github.io/docs/command-reference/k3ai this page abuses the <details> element and leads to undesirable UX. People who want to look for information about a command have to browse through all the dropdowns, clicking on them one-by-one. Also, the <summary>, per the HTML spec, should only contain inline elements, so putting headings here is inappropriate. You'd rather want to use separate doc pages instead. Remember, there's no tax on the Internet for taking extra space!

Yeah the command-reference need to be re-designed but I tried an approach that could make sense..I see what you mean and I'll follow your suggestion!

Oh, thanks for let me know this !
Also I've signed the CLA..I think the bot just need to re-check it at this point. Thanks again for your help and suggestions!

@Josh-Cena
Copy link
Collaborator

No problem. It can take a while for the CLA bot to update. I'll check-in tomorrow morning

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 21, 2022
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Copy link
Collaborator

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Okay, right on time :D

@Josh-Cena Josh-Cena merged commit 1777fc4 into facebook:main Mar 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants