update docs

[korryu3]

Summary by CodeRabbit

• Documentation

  • Added comprehensive setup and development guides to the project documentation.
  • Reorganized documentation structure for improved accessibility.
  • Updated default configuration values for consistency.

• Chores

  • Refactored internal systems to improve maintainability.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation updates reflecting configuration and utility system refactoring: EventChannelConfig renamed to ChannelConfig with get_instance() classmethod pattern, utility function signatures updated with ctx parameters and bool return types, and ARCHIVE_EVENT_CATEGORY_NAME default adjusted across setup documentation.

Changes

Cohort / File(s)	Summary
Project structure and documentation index README.md	Added docs/ directory documentation section with links to SETUP.md and DEVELOPMENT.md; updated ADD_COMMAND.md reference to proper markdown link format.
Architecture and configuration documentation docs/ARCHITECTURE.md	Updated to document EventChannelConfig → ChannelConfig rename and migration from __new__ to get_instance() classmethod pattern; updated get_next_event_index signature to accept explicit category name parameters instead of config object; reflected import path changes.
Validation and utility functions documentation docs/UTILITIES.md	Updated signatures for validate_channel_restriction, validate_channel_in_category, parse_member_mentions, and validate_role_safety to accept ctx parameter and return bool instead of str | None; updated get_next_event_index and find_event_channel_by_name signatures; reflected ChannelConfig instantiation via get_instance().
Channel restriction feature documentation docs/CHANNEL_RESTRICTION.md	Updated all EventChannelConfig references to ChannelConfig; changed ChannelConfig instantiation from direct call to ChannelConfig.load(ctx); documented expanded ChannelConfig attributes (event_request_channel_name, event_category_name, archive_event_category_name); updated file path references from event_config.py to channel_config.py.
Setup and configuration documentation docs/SETUP.md	Changed ARCHIVE_EVENT_CATEGORY_NAME default value from "archived-event" to "archived" across environment sample, help table, server setup steps, and directory structure examples.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

• Consistent refactoring pattern: All changes follow the same architectural migration (EventChannelConfig → ChannelConfig, signature updates across multiple utilities)
• Documentation-only scope: No code logic changes; verification focuses on accuracy and cross-file consistency
• Areas requiring attention:
  • Verify all EventChannelConfig references have been replaced with ChannelConfig across all five documentation files
  • Confirm import path updates (event_config.py → channel_config.py) are consistent throughout
  • Validate that updated function signatures in UTILITIES.md align with their usage examples in ARCHITECTURE.md and CHANNEL_RESTRICTION.md
  • Cross-check that all new ChannelConfig attributes are documented consistently in UTILITIES.md and CHANNEL_RESTRICTION.md

Poem

🐰 With whiskers twitched and code refactored clean,
EventChannelConfig fades—ChannelConfig's seen!
From \new\ to get_instance they hopped,
Signatures updated, defaults now swapped,
Documentation carrot crops—harvest complete! 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title "update docs" is vague and generic, failing to convey what specific documentation changes were made beyond general updates.	Provide a more specific title that describes the primary documentation changes, such as 'Refactor configuration API and update documentation' or 'Replace EventChannelConfig with ChannelConfig throughout docs'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch update-docs

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4ed25f6 and ed8d5dd.

📒 Files selected for processing (5)

• README.md (2 hunks)
• docs/ARCHITECTURE.md (8 hunks)
• docs/CHANNEL_RESTRICTION.md (6 hunks)
• docs/SETUP.md (4 hunks)
• docs/UTILITIES.md (6 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Agent

🔇 Additional comments (11)

docs/SETUP.md (1)

52-52: ✅ Documentation consistency maintained.

The default value updates for ARCHIVE_EVENT_CATEGORY_NAME ("archived-event" → "archived") are consistently applied across all four locations (environment sample, help table, setup instructions, and directory structure). No issues detected.

Also applies to: 64-64, 74-74, 87-87

README.md (1)

12-12: ✅ Documentation discovery and navigation improvements.

The addition of the docs/ directory entry, new "📚 ドキュメント" section, and explicit cross-links improve documentation discoverability. Link format is correct and targets appropriate files (SETUP.md, DEVELOPMENT.md, ADD_COMMAND.md).

Also applies to: 19-25, 152-152

docs/CHANNEL_RESTRICTION.md (1)

90-90: ✅ EventChannelConfig → ChannelConfig migration consistently applied.

All references to the old EventChannelConfig class and event_config.py module are updated to ChannelConfig and channel_config.py. Method invocations (ChannelConfig.load(ctx)) and documentation are internally consistent. Attribute references remain aligned with the new class.

Verify that:

1. ChannelConfig.load(ctx) is implemented as an async method accepting a discord.Interaction context
2. ChannelConfig exposes all referenced attributes: event_request_channel_name, event_category_name, archive_event_category_name

Also applies to: 102-102, 110-110, 138-138, 281-281, 308-308, 348-348

docs/ARCHITECTURE.md (1)

129-129: ✅ Architectural documentation accurately reflects API refactoring.

ChannelConfig singleton pattern with get_instance() classmethod is clearly documented. The get_next_event_index() function signature change (replacing single config parameter with explicit event_category_name and archive_event_category_name parameters) is well-explained with algorithm details and concrete examples. Documentation flows logically from pattern definition to usage to algorithm.

Verify implementation alignment:

1. ChannelConfig.get_instance() classmethod exists and properly caches the singleton
2. get_next_event_index(guild, event_category_name, archive_event_category_name) function signature exists in src/utils/channel_utils.py
3. Function implementation actually scans both event and archive categories using regex r"^(\d+)-"

Also applies to: 132-141, 153-153, 155-156, 176-189

docs/UTILITIES.md (7)

18-36: Validate validate_channel_restriction() API signature and behavior.

Documentation shows signature: validate_channel_restriction(ctx, allowed_channel_name, must_be_in=True) with return type bool and claims error messages are auto-sent. Verify this matches the actual implementation—specifically that:

1. The function is async and properly awaits
2. Error messages are indeed auto-handled (no manual error sending needed by caller)
3. Parameter name allowed_channel_name matches implementation

---

41-51: Validate validate_channel_in_category() API changes.

Signature documented as validate_channel_in_category(ctx, channel, category_name) (removed config parameter, added ctx), with return type bool. Confirm:

1. Implementation accepts these exact parameters
2. Error messaging is auto-handled
3. Function is async

---

61-71: Validate parse_member_mentions() API refactoring.

Signature changed to parse_member_mentions(ctx, members_str, guild) with return type list[discord.Member] | None. Verify:

1. Parameter names match actual implementation
2. Guild parameter is now required (used to derive members from context)
3. Function properly handles None/error cases with auto-messaging

---

94-103: Validate validate_role_safety() ctx parameter addition.

Documentation shows new signature: validate_role_safety(ctx, role) (added ctx parameter), return type bool, with auto-error handling. Confirm:

1. ctx parameter is actually added to implementation
2. Error messages are auto-sent (no manual handling required)
3. Return type is bool (not error object or None)

---

212-234: Validate get_next_event_index() signature refactoring.

Documentation shows significant change from get_next_event_index(guild, config) to get_next_event_index(guild, event_category_name, archive_event_category_name). Usage example demonstrates ChannelConfig.get_instance() call to derive category names. Confirm:

1. New function signature exists with these exact parameters
2. Usage pattern (extracting category names from ChannelConfig and passing explicitly) is the intended API
3. Two-category scanning algorithm is actually implemented
4. Return type remains int

---

508-532: Validate ChannelConfig properties and location.

Documentation references src/utils/channel_config.py with class ChannelConfig and properties: event_category_name, archive_event_category_name, event_request_channel_name, club_category_name (NEW), clubs_request_channel_name (NEW). Verify:

1. File location and class name match actual implementation
2. All documented properties exist and are accessible
3. club_category_name and clubs_request_channel_name are new additions (not previously in EventChannelConfig)
4. get_instance() classmethod exists and properly implements singleton caching

---

1-100: Documentation signatures verified against implementations.

All function signatures shown in the documentation snippet match their implementations:

• validate_channel_restriction ✓ async, parameters and return type align
• validate_channel_in_category ✓ async, parameters and return type align
• parse_member_mentions ✓ async, parameters and return type align
• validate_role_safety ✓ async, parameters and return type align
• get_next_event_index ✓ confirmed in src/utils/channel_utils.py with matching signature
• ChannelConfig class ✓ confirmed with expected attributes and get_instance classmethod

The provided documentation snippet covers only through the validation utilities section. Verification of documentation for get_next_event_index and ChannelConfig beyond line 100 cannot be completed based on the provided snippet.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
4. 📊 Contributor Summary — Include a Markdown table showing contributions:
   | Contributor | Lines Added | Lines Removed | Files Changed |
5. ✔️ Additional Notes — Add any extra reviewer context.
   Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

This PR updates documentation to reflect recent code refactoring changes, primarily the renaming of EventChannelConfig to ChannelConfig and the change of the default archive category name from archived-event to archived.

• Updates all references from EventChannelConfig to ChannelConfig across documentation
• Updates file paths from src/utils/event_config.py to src/utils/channel_config.py
• Updates function signatures and parameter names to match current implementation
• Changes default archive category name from archived-event to archived for consistency

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
docs/UTILITIES.md	Updates function signatures, parameter names, return types, and usage examples for validation and channel utilities; adds new config properties for club functionality
docs/SETUP.md	Updates default value for ARCHIVE_EVENT_CATEGORY_NAME from archived-event to archived throughout the setup instructions
docs/CHANNEL_RESTRICTION.md	Updates all references to EventChannelConfig to ChannelConfig and corrects file path references
docs/ARCHITECTURE.md	Updates code examples showing ChannelConfig usage pattern with get_instance() method and corrects class references
README.md	Adds documentation section with links to setup and development guides; updates reference format to use markdown links

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.