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: simplify readme for npm #47

Merged
merged 2 commits into from
Nov 27, 2023
Merged

docs: simplify readme for npm #47

merged 2 commits into from
Nov 27, 2023

Conversation

t1agob
Copy link
Contributor

@t1agob t1agob commented Nov 27, 2023

simplify readme file and point to full documentation

Signed-off-by: Tiago Barbosa tbarbos@hotmail.com

Description

This PR simplifies the README file (that is used for NPM) and points to the full documentation that will be the one-stop-shop for docs for all projects.

Type of change

  • New feature (non-breaking change which adds functionality)
  • Fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have performed a self-review of this change
  • Changes have been tested
  • Changes are documented
  • Changes generate no new warnings
  • PR title follows conventional commit semantics

If this is a breaking change 👇

  • I have documented the migration process
  • I have implemented necessary warnings (if it can live side by side)

Acknowledgement

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

t1agob and others added 2 commits November 27, 2023 12:00
simplify readme file and point to full documentation

Signed-off-by: Tiago Barbosa <tbarbos@hotmail.com>
@t1agob t1agob merged commit 243224f into next Nov 27, 2023
2 checks passed
@t1agob t1agob deleted the docs/simplify-readme branch November 27, 2023 12:10
t1agob added a commit that referenced this pull request Dec 10, 2023
* chore(dependencies): ⬆️ add support for react 18+ (#43)
* chore(dependencies): Bump up backstage versions (#44)
* chore(dependencies): 📌 upgrade backstage dependencies
* docs(docs): 📝 simplify readme file and point to full documentation (#47)
* chore(deps): bump @adobe/css-tools from 4.3.1 to 4.3.2 (#48)
* fix: Move react strict dependencies (#49)

Signed-off-by: Tiago Barbosa <tbarbos@hotmail.com>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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.

1 participant