search

kiranma72 / abdm-docs

Documentation on various ABDM building blocks for developers
MIT License
4 stars 10 forks source link

General navigation and page organization #20

Open angshu opened 1 year ago

angshu commented 1 year ago

For each page, it would be good to have

  1. Navigation - prev and next
  2. See also section
  3. Need a contextual section for external links like videos, webinars etc. e.g If a video is there on ABHA registation, mention in "see also section"
  4. Add disclaimer about examples, explain how to generate the API calls from the openAPI spec. (This maybe resolved from what I heard the other day, about how you are showing snippets)

also,

  1. we need a section for policy guidelines
  2. Need section and crosslinks (From other pages) for external resources like videos, webinars etc
  3. Explaining the capabilities through workflows may be better. Needs more discussion
  4. Explaining through "personas" gives perspective and provides lot of context. E.g. explain through a Doctor (Dr. Sam at Victoria) or CHO (Asha Devi) - caring for "Devi Prasad in Bangalore Urban", "Hina Patel at Mugalur, Anekal"