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.

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

Jump to bottom

Include READMEs in main framework pages of the API documentation #47717

Merged
merged 1 commit into from
Mar 30, 2023
Merged

Include READMEs in main framework pages of the API documentation #47717

merged 1 commit into from
Mar 30, 2023

Commits on Mar 21, 2023

  1. Include READMEs in main framework pages of the API documentation 

    Currently when opening the main framework pages there is no introduction
to the framework. Instead we only see a whole lot of modules and the
`gem_version` and `version` methods.

By including the READMEs using the `:include:` directive each frameworks
has a nice introduction.
For markdown READMEs we need to add the :markup: directive.

[ci-skip]

Co-authored-by: zzak <zzakscott@gmail.com>
    @p8 @zzak
    p8 and zzak committed Mar 21, 2023
    Configuration menu
    Copy the full SHA
    7c94708 View commit details
    Browse the repository at this point in the history