Description
As we get close to launch, we must ensure that our documentation is clear, accurate, and appropriately styled for our users.
Conditions of acceptance
- Update the link in the main API description
- Issue: " see the [https://wikimedia-attribution.toolforge.org/attribution-signals/overview.html Attribution Framework]." displays, instead of appropriately displaying the "Attribution Framework" as a link.
- Update "Contact the developer" to link to an Attribution API talk page instead of the noc email address.
- Text should read "Have questions or comments about this API? Help shape the experience and functionality while it's in beta by [ < Talk Page TBD > | joining the discussion ]." --> Halley is creating the artifacts for this today.
- Update 'title' parameter to have appropriate casing for REST Sandbox
- Current text "In the Rest Sandbox" should read "In the REST Sandbox"
- Fix 'expand' property link
- Current value of "Allows the caller to include additional types of signals in the response, following the [https://wikimedia-attribution.toolforge.org/ Attribution Framework]" is not actually linking for the Attribution Framework.
- Display available enum values for 'expand'. They used to display, so not sure what happened.
- Current description does not include the available values of 'trust_and_relevance' and 'calls_to_action'
- There is an example of the "Available values: " pattern for request parameter enums on /v1/page/{title}/history in the MW REST flat routing structure
- Add callout to qqq file that OADs expect Markdown and not wikitext; translators should not alter the markdown structure.