Skip to content

docs/update-docs - #259

Closed
leonardodimarchi wants to merge 2 commits into
voidcosmos:mainfrom
leonardodimarchi:docs/update-docs
Closed

docs/update-docs#259
leonardodimarchi wants to merge 2 commits into
voidcosmos:mainfrom
leonardodimarchi:docs/update-docs

Conversation

@leonardodimarchi

@leonardodimarchi leonardodimarchi commented Jul 21, 2026

Copy link
Copy Markdown

This PR improves the project documentation across the main README files, API docs, and contribution guides. 📜

What changed

  • Updated and clarified wording in the English and translated READMEs
  • Improved consistency for examples and CLI option descriptions
  • Added a Portuguese contribution guide and linked it from the Portuguese README
  • Reviewed and cleaned up markdown issues for better readability

Decisions made

  • Kept the English README as the main reference for i18n links (easier to maintain)
  • Kept anchor tags and markdown structure stable where appropriate

This update is documentation-focused and aims to make the project easier to understand for both new users and contributors.

(I have been using this tool for a few years now. Great job, everyone)

@leonardodimarchi
leonardodimarchi force-pushed the docs/update-docs branch 4 times, most recently from 598dc27 to 97db142 Compare July 21, 2026 20:57
@leonardodimarchi

Copy link
Copy Markdown
Author

Hi @zaldih!

I'm updating the documentation, and Codacy is reporting an issue with the H1 heading at the beginning of the file:

Expected: [None]; Actual: # Como contribuir para o NPKILL 🎉

Is this rule correct? Should I remove the H1 headings from CONTRIBUTING files to comply with the current Codacy rules?

@leonardodimarchi

Copy link
Copy Markdown
Author

Closing this PR based on the decision to keep English as the only official language for npkill v1.0, as mentioned in this comment.

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