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 README.md's #10749

Closed
wants to merge 5 commits into from
Closed

Update README.md's #10749

wants to merge 5 commits into from

Conversation

evanSe
Copy link
Member

@evanSe evanSe commented Jan 24, 2024

In general, we aim to enhance the initial user experience when encountering our repository. The purpose of this pull request is to take a step towards achieving that goal.

The changes introduced in this pull request are as follows:

Changes

  • Updated the "Get started with Handsontable" link to direct users to the documentation instead of the wrapper subfolder.
  • Removed type="text/javascript" from scripts.
  • Updated handsontable/README.md to align with the changes made in README.md.
  • Improved tutorial sections in all README.md files.
  • Added autoWrapRow: true, to README.md and wrapper files.
  • Added autoWrapCol: true, to README.md and wrapper files.
  • Reworded the mention of jsDelivr to simply "CDN."
  • Updated the Angular icon to a new version.
  • Changed npm install to npm i in README.MD.

These modifications aim to enhance consistency in our documentation and streamline the user's journey by linking directly to our documentation, eliminating redundant information present in another README.MD.

[skip changelog]

@evanSe evanSe self-assigned this Jan 24, 2024
#### Using a package manager

Get Handsontable from [npm](https://www.npmjs.com/package/handsontable), [Yarn](https://yarnpkg.com/package/handsontable) or [NuGet](https://www.nuget.org/packages/Handsontable).
Get Handsontable from your package manager of choice
Copy link
Contributor

Choose a reason for hiding this comment

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

why are we removing those links?

Copy link
Member Author

Choose a reason for hiding this comment

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

I definitely want to remove NuGet, and was thinking we shouldn't really be informing users what a package manager is.

Copy link
Member

Choose a reason for hiding this comment

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

  1. It's a weird juxtaposition of the NPM headline and mentioning any "package manager of choice"
  2. This kind of suggests we support every possible package manager, and I'm pretty sure it's not true (there's probably some obscure package manager created as I write this sentence...)

colHeaders: true
colHeaders: true,
height: 'auto',
autoWrapRow: true,
Copy link
Member

Choose a reason for hiding this comment

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

I know this is what the default setup should look like now, but mentioning

  autoWrapRow: true,
  autoWrapCol: true,

in every demo, even the simplest one, suggests that these options are somehow crucial to initializing Handsontable, and that's not true.

If we want them to be enabled by default, we should make them enabled by default.

Copy link
Member Author

Choose a reason for hiding this comment

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

That is the plan, but we cannot implement it until next major release. For now, we will add it to everything.

@evanSe evanSe closed this May 15, 2024
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.

None yet

4 participants