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

docs: Finish cleaning up and promote the API docs #283

Open
jaredcwhite opened this issue Apr 12, 2021 · 0 comments
Open

docs: Finish cleaning up and promote the API docs #283

jaredcwhite opened this issue Apr 12, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jaredcwhite
Copy link
Member

jaredcwhite commented Apr 12, 2021

NOTE: I now consider it absolutely imperative that v1.0 ship with 100% YARD comments…I'm not saying codebase coverage will be 100%, but rather that of the comments in the codebase, they will all be in the YARD format.


We've been running https://api.bridgetownrb.com (now on Render instead of Netlify) for a while not, but it hasn't been publicized anywhere. That's OK for most people using Bridgetown in a basic way just to build a website, but for anyone who starts wanting to get into advanced plugin development or even really in-depth Ruby templates, they're going to need to know more about the internals of Bridgetown.

So let's get #47 a bit farther along and the officially "launch" the API docs. I think after the release of 0.21 will be a good opportunity to do that.

@jaredcwhite jaredcwhite added the documentation Improvements or additions to documentation label Apr 12, 2021
@jaredcwhite jaredcwhite added this to the 0.21 "Broughton Beach" milestone Apr 12, 2021
@jaredcwhite jaredcwhite pinned this issue Jun 6, 2021
@jaredcwhite jaredcwhite modified the milestones: 0.22 "TBD", 0.21.1 Jul 12, 2021
@jaredcwhite jaredcwhite modified the milestones: 0.21.1, 0.22 "TBD" Aug 9, 2021
@jaredcwhite jaredcwhite modified the milestones: 0.22, 1.0 Sep 24, 2021
@jaredcwhite jaredcwhite unpinned this issue Dec 20, 2021
@jaredcwhite jaredcwhite modified the milestones: 1.0, 1.1 Apr 2, 2022
@jaredcwhite jaredcwhite modified the milestones: 1.1, 2.0 May 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant