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

How to best document the gem #119

Open
mmenanno opened this issue Jan 17, 2024 · 2 comments
Open

How to best document the gem #119

mmenanno opened this issue Jan 17, 2024 · 2 comments
Labels
research Issues focused on exploration that will likely result in other issues

Comments

@mmenanno
Copy link
Owner

This gem will obviously need to have documentation, need to look into the best way to do that.

@mmenanno mmenanno added the research Issues focused on exploration that will likely result in other issues label Jan 17, 2024
@mmenanno
Copy link
Owner Author

Looks like the best place to start would be to use YARD docs https://github.com/lsegal/yard

There is also a yard plugin to pull sorbet sigs into the documentation https://github.com/dduugg/yard-sorbet

And something like this can be used to push the docs to gh pages https://www.reddit.com/r/ruby/comments/170r1a6/upload_yard_docs_to_github_pages/

@mmenanno mmenanno moved this from Backlog to In progress in LunchMoney Ruby Development Jan 23, 2024
@mmenanno mmenanno moved this from In progress to Backlog in LunchMoney Ruby Development Jan 28, 2024
@mmenanno mmenanno moved this from Backlog to In progress in LunchMoney Ruby Development Jan 31, 2024
@mmenanno
Copy link
Owner Author

mmenanno commented Feb 1, 2024

Examples of every call have been added to https://halorrr.github.io/lunchmoney/LunchMoney/Api.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
research Issues focused on exploration that will likely result in other issues
Projects
Status: In progress
Development

No branches or pull requests

1 participant