search

nxext / nx-extensions-ionic

Nx Extension for Ionic
MIT License
33 stars 8 forks source link

Several links to wrong documenation website #23

Open MatthijsReyers opened 8 months ago

MatthijsReyers commented 8 months ago

Describe the bug Several of the packages and README's in this repo link to the nxext.dev website for their documentation, but this website has no documentation for the ionic next packages. The main README in this repo links to nxext.github.io for the documentation. This is obviously very frustrating for a user of the ionic packages as it can make setting up an nx repo with an ionic app a difficult scavenger hunt of looking for the most up to date documentation and figuring out compatible packages.

A quick grep -R "nxext.dev reveals that there are several places where users are sent to the wrong website.

packages/capacitor/package.json:  "homepage": "https://nxext.dev/docs/capacitor/getting-started.html",
packages/ionic-angular/package.json:  "homepage": "https://nxext.dev/docs/ionic-angular/overview.html",
packages/ionic-angular/README.md:For more complete documentation, visit [nxext.dev](https://nxext.dev/docs/ionic-angular/overview.html).
packages/ionic-angular/README.md:Visit the official [Getting Started](https://nxext.dev/docs/ionic-angular/getting-started.html) documentation.
packages/ionic-react/package.json:  "homepage": "https://nxext.dev/docs/ionic-react/overview.html",
packages/ionic-react/README.md:For more complete documentation, visit [nxext.dev](https://nxext.dev/docs/ionic-react/overview).
packages/ionic-react/README.md:Visit the official [Getting Started](https://nxext.dev/docs/ionic-react/getting-started) documentation.

While it would be most convenient for the ionic packages documentation to be on nxext.dev, I get the impression that that is not the path what the maintainers have chosen so I'll be opening a pull request to update the links later today. Let me know if that is the correct course of action or if I can do something else to help make the documentation more user friendly!

DominikPieper commented 8 months ago

Hey, thanks for the PR. I already plan for some Ideas how to integrate the docs back into one page, while keeping the repos seperate.

Thanks for changing this to the temporare domain.

DominikPieper commented 8 months ago

Could you please run "nx format:write" and commit it. So the linter is satisfied

MatthijsReyers commented 8 months ago

No problem, I just pushed it