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 getting started>download page #2908

Merged

Conversation

hannahiss
Copy link
Member

@hannahiss hannahiss commented Mar 21, 2025

Note: Please transform - [ ] into - (NA) in the description when things are not applicable

Related issues

#2900

Description

Motivation & Context

This page is linked from the homepage

Types of change

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

Live previews

Copy link

netlify bot commented Mar 21, 2025

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 7404a20
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/67ed1fe200d266000836afbe
😎 Deploy Preview https://deploy-preview-2908--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.

@hannahiss hannahiss marked this pull request as ready for review March 24, 2025 14:25
@hannahiss hannahiss requested a review from vprothais March 24, 2025 14:25
@louismaximepiton louismaximepiton linked an issue Mar 25, 2025 that may be closed by this pull request
2 tasks
Copy link
Collaborator

@MaxLardenois MaxLardenois left a comment

Choose a reason for hiding this comment

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

Some comments to discuss, nothing blocking except the Package managers section I think.

- `style` - path to OUDS Web's non-minified CSS that's been compiled using the default settings (no customization)

{{< callout info >}}
{{< partial "callouts/info-npm-starter.md" >}}
Copy link
Collaborator

Choose a reason for hiding this comment

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

In this callout we refer to Bootstrap and not OUDS Web, as we do not have an examples repository this might be ok but I think we should at least mention that Bootstrap's examples are 'somewhat' compatible with OUDS Web... Or getting rid of this callout for now

Copy link
Collaborator

Choose a reason for hiding this comment

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

This starter is already listed in the "example" page. A callout is available on the example page explaining very briefly how to alert bootstrap example for them to work with Ouds. Maybe we could replace the direct link to the repo here by a link to the starter section of example page (/examples/#starters) ?
@hannahiss what do you think ?

@vprothais vprothais added this to the OUDS milestone Apr 1, 2025
@vprothais vprothais added the 📖 documentation Improvements or additions to documentation label Apr 1, 2025
@vprothais vprothais merged commit bdcf930 into ouds/main Apr 2, 2025
11 checks passed
@vprothais vprothais deleted the ouds/main-2900-docs-add-getting-started-download-page branch April 2, 2025 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation
Projects
Development

Successfully merging this pull request may close these issues.

[OUDS] docs: add 'Getting started > Download' page
3 participants