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

Jump to bottom

Dynamically generate configuration docs using YARD #968

Merged

joelhawksley merged 10 commits into main from config-docs

Jun 17, 2021

Contributor

joelhawksley commented Jun 16, 2021 •

edited

This PR adds documentation for configuration options, generated using YARD.

I've reused some code @khiga8 wrote for Primer ViewComponents to extract mattr_accessors.

I also took the liberty of sorting the existing instance methods alphabetically.

[Closes #953]


          Dynamically generate configuration docs using YARD

f8f3729

[Closes #953]

joelhawksley force-pushed the config-docs branch from 64dc4c6 to f8f3729 Compare

joelhawksley requested a review from


          sort method names alphabetically

c38b2b6

github-pages bot temporarily deployed to github-pages

Inactive

joelhawksley marked this pull request as draft

joelhawksley and others added 2 commits


          Merge branch 'main' into config-docs

f1f5741


          add changelog

75a4cb3

github-pages bot temporarily deployed to github-pages

Inactive

Spone reviewed

View changes

Rakefile Show resolved Hide resolved

Spone reviewed

View changes

lib/view_component/previewable.rb Outdated Show resolved Hide resolved

Collaborator

Spone commented Jun 16, 2021

👍

Do you think it could be useful to mention the config.generators.template_engine and config.generators.test_framework settings on this page as well? They are not specific to ViewComponent but I guess some people may look for this kind of setting on this page.

Also, what do you think about having a dedicated "Configuration" item in the website navigation? (maybe as a child of "API")


          Update Rakefile

8da9f06

Co-authored-by: Hans Lemuet <Spone@users.noreply.github.com>

github-pages bot temporarily deployed to github-pages

Inactive


          Update lib/view_component/previewable.rb

c206d6e

Co-authored-by: Hans Lemuet <Spone@users.noreply.github.com>

github-pages bot temporarily deployed to github-pages

Inactive


          add backticks to instance methods

57578a7

Contributor Author

joelhawksley commented Jun 16, 2021

They are not specific to ViewComponent but I guess some people may look for this kind of setting on this page.

@Spone that's a tricky one. I could go either way. I'll give it some thought, this PR isn't going to be done today 😄


          method name formatting

245c00f

github-pages bot temporarily deployed to github-pages

Inactive


          add API docs for two class methods

58a7ab8

github-pages bot temporarily deployed to github-pages

Inactive

joelhawksley marked this pull request as ready for review

joelhawksley marked this pull request as draft


          copy change, remove backticks

7fbcf38

joelhawksley marked this pull request as ready for review

github-pages bot temporarily deployed to github-pages

Inactive

Contributor Author

joelhawksley commented Jun 17, 2021

@Spone I think I've gotten this to a good point for now. I ended up removing the backticks as they made visually scanning the page difficult to my eyes.

I think we should aim to flesh out the documentation in further PRs and then revisit the idea of splitting it up into pages.

manuelpuyol approved these changes

View changes

joelhawksley merged commit 8682057 into main

34 checks passed

joelhawksley deleted the config-docs branch

Spone mentioned this pull request

504 previews with sample source code #667

Merged

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