Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR removes the Advanced Usage documentation file and updates the project documentation links to improve clarity and accuracy. The changes eliminate outdated or potentially confusing advanced documentation while maintaining the core documentation structure.
- Removes the entire advanced usage documentation file
- Updates Japanese README to remove reference to advanced usage documentation
- Updates English README to remove reference to advanced usage documentation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/advanced-usage.md | Complete removal of advanced usage documentation file |
| README_ja.md | Removes link to advanced usage documentation from Japanese README |
| README.md | Removes link to advanced usage documentation from English README |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| - **[Strong Parameters](docs/strong-parameters.md)** - 自動 permit リスト生成 | ||
| - **[エラーハンドリング](docs/error-handling.md)** - フラットと構造化エラーフォーマット | ||
| - **[シリアライゼーション](docs/serialization.md)** - パラメータのハッシュ・JSON変換 |
There was a problem hiding this comment.
[nitpick] The removal of the advanced usage documentation link may leave users without guidance for complex scenarios. Consider either keeping essential content from the removed file in other documentation sections or adding a note about where users can find advanced usage patterns.
| - **[Strong Parameters](docs/strong-parameters.md)** - 自動 permit リスト生成 | |
| - **[エラーハンドリング](docs/error-handling.md)** - フラットと構造化エラーフォーマット | |
| - **[シリアライゼーション](docs/serialization.md)** - パラメータのハッシュ・JSON変換 | |
| - **[シリアライゼーション](docs/serialization.md)** - パラメータのハッシュ・JSON変換 | |
| - **高度な利用方法について**: 複雑なシナリオや高度な使用例については、[English README](README.md) または GitHub リポジトリのドキュメントをご参照ください。 |
| - **[Strong Parameters](docs/strong-parameters.md)** - Automatic permit list generation | ||
| - **[Error Handling](docs/error-handling.md)** - Flat and structured error formats | ||
| - **[Serialization](docs/serialization.md)** - Converting parameters to hashes and JSON |
There was a problem hiding this comment.
[nitpick] The removal of the advanced usage documentation link may leave users without guidance for complex scenarios. Consider either keeping essential content from the removed file in other documentation sections or adding a note about where users can find advanced usage patterns.
| - **[Strong Parameters](docs/strong-parameters.md)** - Automatic permit list generation | |
| - **[Error Handling](docs/error-handling.md)** - Flat and structured error formats | |
| - **[Serialization](docs/serialization.md)** - Converting parameters to hashes and JSON | |
| - **[Serialization](docs/serialization.md)** - Converting parameters to hashes and JSON | |
| - **Advanced Usage** - For complex scenarios and advanced usage patterns, please refer to the examples in the documentation files above, or [open an issue](https://github.com/Syati/structured_params/issues) if you need guidance on specific advanced use cases. |
The Readme file has been updated for better clarity and accuracy. This includes improvements in wording and structure to provide clearer guidance to users and contributors.