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.

Sign up for GitHub

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

Jump to bottom

fix(docs/general): improvements #1307

Merged
merged 7 commits into from
Jul 30, 2024
Merged

fix(docs/general): improvements #1307

merged 7 commits into from
Jul 30, 2024

Conversation

matthiashader
Copy link
Collaborator

💡 What is the current behavior?

  • The documentation pages of the components are not standardized
  • Naming is not equal (usage, example, .... | API , Properties)

GitHub Issue Number: #N/A, [IX-1122], [IX-459]

🆕 What is the new behavior?

  • documentation pages are standardized
  • naming is equal on pages

Note:

  • API (component-name) -> api would appear in search!
  • should file header also be replaced?

🏁 Checklist

A pull request can only be merged if all of these conditions are met (where applicable):

  • 🦮 Accessibility (a11y) features were implemented
  • 🗺️ Internationalization (i18n) - no hard coded strings
  • 📲 Responsiveness - components handle viewport changes and content overflow gracefully
  • 📄 Documentation was reviewed/updated (pnpm run docs)
  • 🧪 Unit tests were added/updated and pass (pnpm test)
  • 📸 Visual regression tests were added/updated and pass (Guide)
  • 🧐 Static code analysis passes (pnpm lint)
  • 🏗️ Successful compilation (pnpm build, changes pushed)

👨‍💻 Help & support

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jun 3, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: bf811c9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 1, 2024

Report of strictNullChecks (strictPropertyInitialization) check

Typescript check

Total errors are the same in both branches

ESLint check

Total ESLint warnings are the same in both branches

@danielleroux danielleroux merged commit db678ea into main Jul 30, 2024
16 checks passed
@danielleroux danielleroux deleted the fix/996-adapt-md branch July 30, 2024 05:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nuke-ellington nuke-ellington nuke-ellington approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@matthiashader @nuke-ellington @danielleroux