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

Update demo readme and main readme #266

Merged
merged 3 commits into from
Jan 27, 2025
Merged

Conversation

bobbravo2
Copy link
Contributor

@bobbravo2 bobbravo2 commented Jan 3, 2025

Description

Onboarding to the project, and trying out the awesome demo. Wanted to make a few small improvements to the docs.

Work left

  • Reconcile the main demo instructions, vs. the packages/demo-app-ts/README.md, and use a link to the correct instructions instead of having 2 sets.

Type of change

  • Documentation content changes

Screen shots / Gifs for design review

See the GitHub UI for the rich markdown previews;
https://github.com/patternfly/react-topology/blob/57765372d242b57321e6ad220ab72d9e7c42b1cb/packages/demo-app-ts/README.md

This PR should also fix the demo image being a 404:

demo module screenshot is not rendering, due to a relative path bug.

@patternfly-build
Copy link

patternfly-build commented Jan 3, 2025

@bobbravo2 bobbravo2 changed the title Update docs Update demo readme and main readme Jan 3, 2025
@bobbravo2 bobbravo2 marked this pull request as ready for review January 6, 2025 18:35
'do-not-delete',
{ name: 'main', channel: 'prerelease', prerelease: 'prerelease' },
],
branches: ['do-not-delete', { name: 'main', channel: 'prerelease', prerelease: 'prerelease' }],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

prettier build from a previous build asked me to make this change in this stage of CI:

yarn run v1.22.22
$ eslint . --ext .js,.jsx,.ts,.tsx --color

/home/runner/work/react-topology/react-topology/packages/module/release.config.js
  2:14  error  Replace `⏎····'do-not-delete',⏎····{·name:·'main',·channel:·'prerelease',·prerelease:·'prerelease'·},⏎··` with `'do-not-delete',·{·name:·'main',·channel:·'prerelease',·prerelease:·'prerelease'·}`  prettier/prettier

✖ 1 problem (1 error, 0 warnings)
  1 error and 0 warnings potentially fixable with the `--fix` option.

@jeff-phillips-18
Copy link
Member

@bobbravo2 Thank you for the contribution!

@jenny-s51 jenny-s51 merged commit dc28e8b into patternfly:main Jan 27, 2025
8 checks passed
@bobbravo2 bobbravo2 deleted the demo-app branch January 27, 2025 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants