Update reference docs with the changes made in V10#6506
Conversation
✅ Deploy Preview for prebid-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| @@ -1,13 +1,13 @@ | |||
| --- | |||
| layout: api_prebidjs | |||
There was a problem hiding this comment.
Since the adServers.dfp.xxx is still present in V10 and higher, an alternative would be to have 2 versions of the file.
- The old
dfpfile, with a warning at the top - The new file
For now, I went for the least amount of work approach and only kept the .gam. version in the docs
| **Kind**: static method of `pbjs`. | ||
|
|
||
| **Returns**: `object` - map | object that contains the bidResponses. | ||
| **Returns**: `object` - map | object that contains for each ad unit the array of bid responses. For backwards compatibility, the arrays expose the array also under the `.bids` property. |
There was a problem hiding this comment.
Not sure if we want to keep the "For backwards compatibility, ..." sentence in here.
I added it because otherwise people might inspect what they get from this method, and discover that it is not in sync with the docs / wonder why there is an additional .bids property present on the array.
| { | ||
| "/9968336/header-bid-tag-0": { | ||
| "bids": [ | ||
| "/9968336/header-bid-tag-0": [ |
There was a problem hiding this comment.
I don't really saw a way to include the .bids property that we have for backwards compatibility here while keeping things readable.
So I just went for the array.
| This method combines publisher-provided parameters with Prebid.js targeting parameters to build a GAM video ad tag URL that can be used by a video player. | ||
|
|
||
| #### Argument Reference | ||
| ## Argument Reference |
There was a problem hiding this comment.
I don't like this, but I had to do it in a few places to satisfy the linter.
Otherwise, I bumped into https://github.com/DavidAnson/markdownlint/blob/main/doc/md001.md .
Note that there are a bunch more files that would violate this rule
There was a problem hiding this comment.
This rule is somehow going rough... I'll disable it for now, because it starts breaking the layout in a couple of places. Sorry for the inconvenience 🙈
There was a problem hiding this comment.
@muuki88 Did you already disable it?
I merged master into my branch and undid those changes, but the linter still complains. I also could not really spot your commit that disabled the rule
There was a problem hiding this comment.
I figured out what changed ( title in fontmatter meta data causes this ) and adapted the styling so this rule can be applied as is.
|
@robin-crazygames thanks for improving the docs ❤️ Could you resolve the merge conflicts? Then I'll take a look |
# Conflicts: # dev-docs/publisher-api-reference/adServers.gam.buildVideoUrl.md
|
@muuki88 I've merged the master branch into this branch, so the conflicts should be resolved |
2 participants
Not all the changes mentioned in the Prebid V10 release notes were reflected in the reference documentation.
I tried to go over the methods mentioned in those docs, and updated the docs accordingly
I've left a few comments already highlighting changes that might warrant a bit more attention.
🏷 Type of documentation
📋 Checklist