Skip to content

Add supporting.md Guide to Simplify Assimilation & Navigation of Documentation Files and Codes#82

Open
0xdfinity wants to merge 4 commits intozama-ai:mainfrom
0xdfinity:main
Open

Add supporting.md Guide to Simplify Assimilation & Navigation of Documentation Files and Codes#82
0xdfinity wants to merge 4 commits intozama-ai:mainfrom
0xdfinity:main

Conversation

@0xdfinity
Copy link
Copy Markdown

@0xdfinity 0xdfinity commented Sep 25, 2025

Description:

This PR introduces a new supporting.md file in the root of the repository, serving as a comprehensive, structured guide to navigate the ZAMA source files. The guide is designed to help both developers and non-technical users explore the repo's content in a logical, educational sequence, reducing the need for manual digging through nested folders and resources

Key features of supporting.md:

  • Mirrors the main sections of the ZAMA Manual (High-Level Overview, Developers, Operators, etc).
  • Provides overviews, key file links (clickable to GitHub blobs), learning paths, and transitions for progressive knowledge building.
  • Includes tips for different audiences and additional repo navigation advice.
  • Creating a centralized, easy-to-follow map of the docs.

This addition enhances accessibility without altering existing files build process. It can be linked from any root README.md in a future update if desired.

Checklist:

  • Added new file: supporting.md to the awesome zama root directory.
  • Verified all links in supporting.md are clickable and point to the correct GitHub blob URLs
  • Ensured the structure is psychologically and educationally sound: Starts with basics, builds progressively, and includes tips for assimilation.
  • Followed Markdown best practices: Consistent headings, bullet points, and formatting for readability.
  • No changes to existing files; this is a pure addition.
  • Tested locally: Rendered the Markdown in a viewer (e.g., GitHub preview) to confirm no broken links or formatting issues.
  • Note in root README.md linking to supporting.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant