Skip to content

🖊️ TinaDocs | Add Comments for Public Info #108

@ssw-yakshaver

Description

@ssw-yakshaver

Requested by: @isaaclombardssw via YakShaver.ai 🦬
cc: @isaaclombardssw, @Marxoz, @wicksipedia, @adamcogan

Hi Team!

  🟥  Watch the video (1 min 20 sec)

  Url from screen share: https://github.com/tinacms/tina-docs

Pain

Add comments to the Tina.io codebase to improve clarity and understanding for developers. Focus on Tina.io-specific components and schemas, providing links to relevant documentation and brief explanations where necessary.

Acceptance Criteria

  1. Comments are added to all Tina.io-specific components in the codebase.
  2. Each comment includes a link to the relevant Tina.io documentation.
  3. Brief explanations are provided for components and schemas that are not immediately obvious.
  4. Ensure comments are clear, concise, and helpful for developers.

Screenshot

Screenshot
Figure: Unclear code requires comments linking to Tina.io documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions