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[DST-519]: Clean up Marigold Docs/ Improve Nav #4161

Merged
merged 33 commits into from
Sep 23, 2024
Merged

Conversation

sarahgm
Copy link
Member

@sarahgm sarahgm commented Sep 12, 2024

Description

What I did:

  • deleted old files (scripts, about , release)
  • updated some faqs
  • improved the navigation structure
  • added overview pages
  • improved folder structure in code (a bit)
  • adjust some links
  • fix typescript error in navigation.tsx
  • update links in other pages on the docs

What should be tested?

  • the documentation,
  • the links working correctly,
  • the look of the navigation,
  • are the new categories suiteable for the content?
  • have a look on the overview pages

Possible Reviewers:

@marigold-ui/developer
@marigold-ui/designer
@KadaStrophe

Copy link

vercel bot commented Sep 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
marigold-docs ✅ Ready (Inspect) Visit Preview 8 resolved Sep 20, 2024 8:42am
marigold-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 20, 2024 8:42am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
marigold-production ⬜️ Ignored (Inspect) Visit Preview 💬 Add feedback Sep 20, 2024 8:42am

Copy link

changeset-bot bot commented Sep 12, 2024

🦋 Changeset detected

Latest commit: a8cdd97

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages
Name Type
@marigold/docs Patch
@marigold/system Patch
@marigold/components Patch
@marigold/icons Patch
@marigold/theme-preset Patch
@marigold/theme-b2b Patch
@marigold/theme-core Patch
@marigold/theme-docs Patch
@marigold/storybook-config Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented Sep 12, 2024

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements
99.62% (-0.01% 🔻)
7807/7837
🟢 Branches
89.43% (-1.34% 🔻)
347/388
🟢 Functions 98.44% 126/128
🟢 Lines
99.62% (-0.01% 🔻)
7807/7837
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / Calendar.tsx
98.99% (-1.01% 🔻)
50% (-50% 🔻)
100%
98.99% (-1.01% 🔻)
🟢
... / Checkbox.tsx
98.33%
66.67% (-23.33% 🔻)
100% 98.33%
🟢
... / Headline.tsx
100%
50% (-50% 🔻)
100% 100%
🟢 system/src/utils.ts 100%
87.5% (-6.94% 🔻)
100% 100%

Test suite run success

569 tests passing in 78 suites.

Report generated by 🧪jest coverage report action from a8cdd97

KadaStrophe
KadaStrophe previously approved these changes Sep 13, 2024
Copy link
Collaborator

@KadaStrophe KadaStrophe left a comment

Choose a reason for hiding this comment

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

<3

@github-actions github-actions bot added the type:feature New feature or component label Sep 16, 2024
@sebald sebald merged commit 380704d into main Sep 23, 2024
15 checks passed
@sebald sebald deleted the clean-up-documentation branch September 23, 2024 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs Improvements or additions to documentation type:feature New feature or component
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants