docs: update readme #28
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Greptile Summary
This PR drastically simplifies the README.md file, reducing it from 554 lines to just 7 lines. The change removes all comprehensive documentation including installation instructions, authentication examples, API method documentation, and detailed usage examples. The new README now contains only a brief description of the Infisical Node.js SDK and a link to external documentation at https://infisical.com/docs/sdks/languages/node.
This represents a documentation consolidation strategy where the maintainers are centralizing all detailed SDK information on the Infisical documentation website rather than maintaining duplicate content in the repository. This approach can reduce maintenance overhead by having a single source of truth for documentation and ensures consistency across different SDK versions. The change fits into a broader pattern of moving from repository-based documentation to centralized web-based documentation that many organizations adopt as their projects mature.
Confidence score: 3/5
- This PR introduces a significant change to developer experience that may frustrate users expecting comprehensive README documentation
- Score reflects the potential negative impact on developer onboarding and discoverability, though the change itself is technically safe
- Pay close attention to the documentation strategy and consider the impact on user experience and adoption
1 file reviewed, 1 comment
README.md
Outdated
|
|
||
| The Infisical SDK provides a convenient way to interact with the Infisical API. | ||
| If you’re working with Node.js, the official Infisical Node.js SDK package is the easiest way to fetch and work with secrets for your application. | ||
| |
There was a problem hiding this comment.
syntax: There's an invisible Unicode character (U+200B zero-width space) on this line that should be removed
| |
There was a problem hiding this comment.
- Let's actually add an MIT license file to all the SDK's. All the SDK's should be MIT.
a. Currently a lot of the SDK's don't have LICENSE files. You can copy the LICENSE file from here: https://github.com/Infisical/kubernetes-operator/blob/main/LICENSE - Remove the "PRs welcome" badge. We don't have proper contribution guidelines for SDK's yet.
- Rename Node JS to Node.js
This applies to all the SDK's. Let's fix the Node.js SDK readme before we move onto the rest to make sure we're aligned
2 participants
No description provided.