android / android/ndk

[DOC] include a bug URL for every API

Open
#1,700 1 comment 0 reactions 0 assignees View on GitHub
docs
Dominant language
No language data
Stars
2.3k
Forks
310
PR merge metrics
No merged PRs in 30d

Description

### URL

https://developer.android.com/ndk/reference

### Problem

The API reference docs should include a bug URL for every API we ship. Folks often end up here asking for API help which we're not able to provide. If each defgroup had a bug URL associated with it we'd know where to point them (and they'd hopefully find it themselves).

We should also probably require a point-of-contact for each API so we know who to CC for questions when needed.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the API reference at https://developer.android.com/ndk/reference and identify how each defgroup is represented. Done means every shipped API defgroup has an associated bug URL; clarify separately whether point-of-contact information is also required, since the issue presents that as a possible follow-up.

Written by the indexing model from the issue text.

Assessment

Tech stack
android
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.