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

[OUDS] Docs: add 'Getting Started > JavaScript' page #2648

Open
wants to merge 2 commits into
base: ouds/main
Choose a base branch
from

Conversation

julien-deramond
Copy link
Member

@julien-deramond julien-deramond commented Jul 25, 2024

Warning

This PR stays valid but is on hold until we actually have our first official JavaScript components for OUDS Web

Related issues

Listed in #2589

Description

This PR adds the "Getting Started > Contribute" page based on:

Important

Everything that is described in this page must be tested!
To help you do the review, I've created some CodePens:

Types of change

  • New documentation (non-breaking change which adds functionality)

Live previews

@julien-deramond julien-deramond added the docs Improvements or additions to documentation label Jul 25, 2024
@julien-deramond julien-deramond added this to the OUDS milestone Jul 25, 2024
@julien-deramond julien-deramond changed the title docs: add 'Getting Started > JavaScript' page [OUDS] Docs: add 'Getting Started > JavaScript' page Jul 25, 2024
Copy link

netlify bot commented Jul 25, 2024

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 94fc64c
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/66a7656c2c178f00081de238
😎 Deploy Preview https://deploy-preview-2648--boosted.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 configuration.

@julien-deramond julien-deramond force-pushed the ouds/main-jd-getting-started-javascript branch from 32ea1ca to 9278d41 Compare July 25, 2024 05:48
Copy link
Member

@louismaximepiton louismaximepiton left a comment

Choose a reason for hiding this comment

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

In the importmap, shouldn't it be @ouds/web instead of ouds-web? anyway it has no impact.

site/content/docs/0.0/getting-started/javascript.md Outdated Show resolved Hide resolved
site/content/docs/0.0/getting-started/javascript.md Outdated Show resolved Hide resolved
@julien-deramond julien-deramond force-pushed the ouds/main-jd-getting-started-javascript branch from c8c9e31 to 30c9afa Compare July 29, 2024 06:55
@julien-deramond julien-deramond force-pushed the ouds/main-jd-getting-started-javascript branch from d8d7bfe to cb82c4f Compare July 29, 2024 07:16
@julien-deramond
Copy link
Member Author

In the importmap, shouldn't it be @ouds/web instead of ouds-web? anyway it has no impact.

Yes, you're right, it's done like this for Popper. I've updated the CodePens and the PR with 94fc64c

@julien-deramond julien-deramond marked this pull request as draft July 30, 2024 09:52
Copy link
Member

@louismaximepiton louismaximepiton left a comment

Choose a reason for hiding this comment

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

LGTM, great work!

@julien-deramond julien-deramond marked this pull request as ready for review July 31, 2024 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation on hold
Projects
Status: In Progress
Status: Need Dev Review
Development

Successfully merging this pull request may close these issues.

2 participants