Skip to content

Conversation

@toshimaru
Copy link
Member

@toshimaru toshimaru commented Oct 26, 2025

ref. toshimaru/sdoc#15


This pull request improves the consistency and clarity of the documentation HTML for the AbstractController and its related modules/classes. The main changes include standardizing the display of type names, moving file lists from the header to a dedicated "Definition files" section, and updating the associated SCSS to match these structural changes.

Key changes:

Documentation Structure Improvements:

Type Display Standardization:

  • Standardized the capitalization of type names in the documentation header, changing "Class" to "class" and "Module" to "module" for all relevant documentation pages. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]

SCSS/CSS Adjustments:

  • Updated the .type and .parent selectors in railsdoc.scss to match the new HTML structure and removed unnecessary styling for ul and li elements within the code documentation.

@toshimaru toshimaru changed the title Update sdoc 20251027 docs: Update sdoc 20251027 Oct 26, 2025
@toshimaru toshimaru changed the title docs: Update sdoc 20251027 docs: Update sdoc (20251027) Oct 26, 2025
@toshimaru toshimaru self-assigned this Oct 26, 2025
@toshimaru toshimaru marked this pull request as ready for review October 26, 2025 16:15
Copilot AI review requested due to automatic review settings October 26, 2025 16:15
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the generated documentation HTML to improve consistency and organization by standardizing type name capitalization and relocating file lists to a dedicated "Definition files" section.

Key changes:

  • Changed type labels from capitalized ("Class"/"Module") to lowercase ("class"/"module") across all documentation pages
  • Moved file lists from header to new "Definition files" section at page bottom
  • Updated SCSS to remove unnecessary list styling and refine type/parent selectors

Reviewed Changes

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

Show a summary per file
File Description
src/classes/ActionDispatch/Session/*.html Updated class/module documentation structure with lowercase type labels and relocated file lists
src/classes/ActionDispatch/Routing/*.html Applied consistent formatting changes to routing-related documentation
src/classes/ActionDispatch/*.html Standardized documentation structure for core ActionDispatch classes and modules
src/classes/ActionController/*.html Updated controller-related documentation with new format
src/_sass/railsdoc.scss Removed list styling and simplified type/parent selector formatting

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

@toshimaru toshimaru merged commit 749e9dc into railsdoc:main Oct 26, 2025
11 checks passed
@toshimaru toshimaru deleted the update-sdoc-20251027 branch October 26, 2025 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant