doc: update README to follow DotfilesLinker #5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for DotfilesLinker to align with the latest guidelines by streamlining and enhancing the README files while removing deprecated configuration and changelog files.
- Removed the outdated git-cliff configuration file (cliff.toml).
- Revised README_ja.md and README.md with improved quick-start, installation, usage examples, and configuration instructions.
- Removed the CHANGELOG.md file.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| cliff.toml | Removed outdated configuration data for git-cliff. |
| README_ja.md | Updated Japanese documentation with clearer sections and examples. |
| README.md | Revised English documentation with improved clarity and examples. |
| CHANGELOG.md | Removed changelog content, likely to simplify documentation. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation to align with the current DotfilesLinker (Go version) implementation and conventions by modifying the README files and removing legacy configuration and changelog files.
- Removed legacy changelog configuration (cliff.toml) and the CHANGELOG.md file.
- Revised both English and Japanese README files to update headings, instructions, and code examples.
- Updated links and environment variable descriptions to reflect current usage.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| cliff.toml | Removed legacy Git-Cliff configuration used for changelogs. |
| README_ja.md | Updated Japanese documentation structure and instructions. |
| README.md | Updated English documentation structure and instructions. |
| CHANGELOG.md | Removed legacy changelog entries. |
Comments suppressed due to low confidence (4)
README_ja.md:6
- [nitpick] Consider standardizing the project name capitalization; if the established convention is 'DotfilesLinker', update this heading accordingly for consistency.
# dotfileslinker (Go版)
README.md:6
- [nitpick] Consider standardizing the project name capitalization; if the repository convention is 'DotfilesLinker', update this heading accordingly for consistency.
# dotfileslinker (Go Version)
README_ja.md:215
- Ensure that the LICENSE.md file exists or update the link to reflect the correct license file name if it differs from LICENSE.md.
このプロジェクトは MIT ライセンスの下で公開されています。詳細は [LICENSE](LICENSE.md) ファイルを参照してください。
README.md:215
- Ensure that the LICENSE.md file exists or update the link to reflect the correct license file name if it differs from LICENSE.md.
This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.
There was a problem hiding this comment.
Pull Request Overview
This PR updates the project documentation to align with the DotfilesLinker approach. Key changes include:
- Removal of the cliff.toml file containing git‑cliff configuration.
- Restructuring and updating both the English (README.md) and Japanese (README_ja.md) documentation with clearer sections such as Quick Start, How It Works, and Configuration.
- Removal of the CHANGELOG.md file.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| cliff.toml | Removed deprecated git‑cliff configuration. |
| README_ja.md | Restructured documentation and updated instructions in Japanese. |
| README.md | Restructured documentation and updated instructions in English. |
| CHANGELOG.md | Removed the changelog file, possibly in favor of a new mechanism. |
Comments suppressed due to low confidence (2)
cliff.toml:1
- The removal of the cliff.toml file eliminates the git‑cliff configuration; please confirm that this removal is intentional and that any necessary changelog generation configurations are updated elsewhere.
# Configuration for git-cliff
CHANGELOG.md:1
- The complete removal of CHANGELOG.md may affect historical release information; please confirm that an alternative changelog mechanism is in place to preserve project history.
# Changelog
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.