Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: add install section on README #45

Merged
merged 3 commits into from
Mar 3, 2024

Conversation

SethFalco
Copy link
Member

@SethFalco SethFalco commented Mar 2, 2024

Clarify how to install the tool locally before the usage instructions. I also reworded parts of the README in general.

Chores

I also did some chores while I was here:

  • Subjectively reorganizes the package.json.
  • Upgrade the translations job to use Node.js v20.
  • Omit the version number from the job name, as it's unnecessary.
  • When parsing a page, if the page's layout is unexpected, call it malformed instead of invalid so it's clearer the content of the page is the problem, as opposed to the page not existing for example.

@SethFalco SethFalco requested a review from kbdharun March 2, 2024 22:43
@SethFalco SethFalco force-pushed the docs/install-guide branch from 669ec90 to 09abe04 Compare March 2, 2024 23:04
@SethFalco SethFalco force-pushed the docs/install-guide branch from 09abe04 to 2e33d58 Compare March 2, 2024 23:06
@kbdharun kbdharun merged commit 652d170 into tldr-pages:main Mar 3, 2024
1 check passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants