search

prebid / Prebid.js

Setup and manage header bidding advertising partners without writing code or confusing line items. Prebid.js is open source and free.
https://docs.prebid.org
Apache License 2.0
1.28k stars 2.05k forks source link

API docs should be autogenerated #1408

Closed rmloveland closed 6 years ago

rmloveland commented 7 years ago

Type of issue

This is a feature request.

Description

Currently our API documentation is maintained separately. In order to avoid docs getting out of sync with the code, we should consider generating docs from the code.

Once generated, the API docs could be copied over to the Prebid.org repo as part of the release process, or in whatever other way seems reasonable to the team.

We could do the same for the various module APIs.

I've attached a couple of Markdown API doc files generated by documentation.js (h/t @dbemiller for the pointer) -- perhaps we could consider adding a gulp docs target to generate these automatically (or whatever else works).

What do y'all think?

publisher-api-reference.txt dfp-ad-server-module-api-reference.txt

stale[bot] commented 6 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.