Skip to content

Update project documentation #3

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
Syati merged 1 commit into from
Sep 5, 2025
Merged

Update project documentation #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ end
- **[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
Comment on lines 53 to 55

Copilot AI Sep 5, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Suggested change
- **[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.

Copilot uses AI. Check for mistakes.
- **[Advanced Usage](docs/advanced-usage.md)** - Type introspection, performance tips, and more

## Example

Expand Down
1 change: 0 additions & 1 deletion README_ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ end
- **[Strong Parameters](docs/strong-parameters.md)** - 自動 permit リスト生成
- **[エラーハンドリング](docs/error-handling.md)** - フラットと構造化エラーフォーマット
- **[シリアライゼーション](docs/serialization.md)** - パラメータのハッシュ・JSON変換
Comment on lines 53 to 55

Copilot AI Sep 5, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Suggested change
- **[Strong Parameters](docs/strong-parameters.md)** - 自動 permit リスト生成
- **[エラーハンドリング](docs/error-handling.md)** - フラットと構造化エラーフォーマット
- **[シリアライゼーション](docs/serialization.md)** - パラメータのハッシュ・JSON変換
- **[シリアライゼーション](docs/serialization.md)** - パラメータのハッシュ・JSON変換
- **高度な利用方法について**: 複雑なシナリオや高度な使用例については、[English README](README.md) または GitHub リポジトリのドキュメントをご参照ください。

Copilot uses AI. Check for mistakes.
- **[高度な使用方法](docs/advanced-usage.md)** - 型内省、パフォーマンスのコツなど

## 例

Expand Down
131 changes: 0 additions & 131 deletions docs/advanced-usage.md
View file
Open in desktop

This file was deleted.