HarmonyOS NEXT (Offline Documentation Navigation)

references/

Progressive Disclosure (Follow in order)

1. Narrow down the scope first (select Kit or task)
   • Kit navigation:

     references/KITS.md

   • Task-oriented:

     references/TASK_MAP.md

2. Accurately locate files next (search path list)
   • Full library path list:

     references/INDEX.md

   • JS/ETS API bucket list:

     references/JsEtsAPIReference/INDEX.md

3. Browse directories only when necessary

   references/JsEtsAPIReference/

   has been layered by buckets:

   modules/

   ,

   topics/

   ,

   capi/headers/

   ,

   types/

   ,

   errors/

   ,

   guides/

   .

Common Searches (copy directly for use)

• Match paths by keyword first:

  rg -n "UIAbility|AbilityStage|Want" references/INDEX.md | head

• Search for a specific

  @ohos.*

  module:

  rg -n "@ohos\\.app\\.ability\\.|@ohos\\.ability\\." references/JsEtsAPIReference/INDEX.md | head

• Search for NDK/C API header files:

  rg -n "^capi/headers/.*(napi|arkui|window|ability).*\\.h\\.md$" references/JsEtsAPIReference/INDEX.md | head

Generation Constraints (avoid pitfalls)

• Do not read all files: First match the path in

  INDEX.md

  , then open the corresponding

  .md

  file.
• Check documentation if unsure: API signatures, input parameters, and return values are subject to the text in

  references/

  , do not complete them based on experience.
• Declarative syntax is preferred for ArkUI: Examples prefer to use

  @Entry

  /

  @Component

  /

  build()

  (unless the document explicitly specifies NDK or system service).