Skip to content

API description checklist compliance review for Brand Registration marketing page #90

Description

@anthorange

Problem description
This issue is based on the Camara Marketing “Checklist for API description review”:
https://github.com/camaraproject/Marketing/blob/main/documentation/SupportingDocuments/Checklist_for_API_description_review.md

The Brand Registration API page reviewed:
https://camaraproject.org/brand-registration/

The page has checklist compliance gaps for:

  • API Description (the image is only illustrative)
  • Use Cases (text format / missing GSMA Use Case Library links)
  • Sub Project Wiki (incorrect prefix / no link)

Expected action
Please update the Brand Registration API documentation page so it matches the checklist by applying the following corrections:

  1. API Description
  • The image is currently illustrative and does not clearly represent a “typical use case” workflow/value for developers (as expected by the checklist).
  1. Use Cases
  1. Sub Project Wiki
  • The correct prefix is "Sub Project Wiki:" (current prefix: "SubProject Wiki:")
  • No link available in the section, just a pointer to the API Wiki section. Proposal: inline the link to the Verified Caller API wiki in this section as well.

Additional context
Checklist reference:
https://github.com/camaraproject/Marketing/blob/main/documentation/SupportingDocuments/Checklist_for_API_description_review.md

Reviewed page export:
https://camaraproject.org/brand-registration/

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions