Skip to content
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.

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

Add documentation intros for Action Controller and Action Dispatch #47840

Merged
merged 1 commit into from
Apr 5, 2023

Conversation

p8
Copy link
Member

@p8 p8 commented Apr 2, 2023

In 7c94708 the READMEs were included for the main framework pages of the API documentation, except for Action Pack. As Action Pack doesn't define any code in the ActionPack namespace, only it's included modules (Action Dispatch, Action Controller and Abstract Controller) are documented.

This adds documentation intro's to the main page for Action Controller and Action Dispatch. The content was copied from the Action Pack README. As Abstract Controller isn't mentioned there, it is skipped for now. [ci-skip]

Before

image

image

After

image

image

In 7c94708 the READMEs were included for
the main framework pages of the API documentation, except for Action Pack.
As Action Pack doesn't define any code in the ActionPack namespace, only
it's included modules (Action Dispatch, Action Controller and Abstract
Controller) are documented.

This adds documentation intro's to the main page for Action Controller
and Action Dispatch. The content was copied from the Action Pack README.
As Abstract Controller isn't mentioned there, it is skipped for now.
[ci-skip]
@p8 p8 merged commit 2fc77e4 into rails:main Apr 5, 2023
8 checks passed
@p8 p8 deleted the docs/actionpack-intros branch April 5, 2023 06:27
@p8
Copy link
Member Author

p8 commented Apr 5, 2023

@zzak Adding lib/action_dispatch.rb caused Rack showing up in the sidebar.
I'm not sure how to fix this.

@zzak
Copy link
Member

zzak commented Apr 5, 2023

@zzak Adding lib/action_dispatch.rb caused Rack showing up in the sidebar.

I'm not sure how to fix this.

@p8 We can revert for now if you are concerned, I will look into it during my day tomorrow.

@zzak
Copy link
Member

zzak commented Apr 6, 2023

Should be fixed by #47875

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants