Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

restructured repo, added demo, added docs, added guide #78

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

andorsk
Copy link
Contributor

@andorsk andorsk commented Jan 9, 2025

Proposal: Expand Repository Structure and Create Starting Points for Each Folder

This Pull Request (PR) proposes significant changes to the repository structure, aimed at improving organization and facilitating contributions. The updates include adding new folders beyond the specification and refactoring the existing structure. Each folder will also include starting point documents or examples to guide contributors and establish a baseline for future work.

Summary of Changes

  1. Expanded Repository Structure

    • Introduces additional folders (docs, profiles, and reference_implementation) to complement the specification folder.
    • Refactors existing content to align with the new structure.
  2. Starting Points for Each Folder

    • Adds initial content to each folder to serve as a foundation for further contributions.

Updated Repository Structure

1. specification

  • Purpose: Contains the core specification documentation.
  • Starting Point: Existing specification documents are retained and refined.
  • Rendered Version: Accessible at GitHub Pages.

2. docs

  • Purpose: Includes user guides, FAQs, and other supportive documentation.
  • Starting Point: An initial "Getting Started Guide" is added to help users understand and interact with the specification.

3. profiles

  • Purpose: Provides a registry of example TRQP profiles for learning and reference.
  • Starting Point: Includes a sample profile template and a basic example profile to illustrate structure and usage.

4. reference_implementation

  • Purpose: Contains a lightweight reference implementation using a JSON-based registry.
  • Starting Point: Adds a minimal working example demonstrating basic functionality, emphasizing simplicity and educational value.

Details of Changes

Refactoring the specification Folder

Adding the docs Folder

  • "Getting Started Guide": Introduces the specification, explains its purpose, and provides step-by-step instructions for engaging with the TRQP.
  • Supportive Documentation: Placeholder documents for FAQs and troubleshooting.

Adding the profiles Folder

  • Sample Profile Template: A reusable template for creating new TRQP profiles.
  • Example Profile: A basic profile illustrating how to define and structure a TRQP profile.

Adding the reference_implementation Folder

  • Minimal JSON Registry Example: Demonstrates how to use a simple JSON file to implement a registry.
  • Educational Comments: Inline documentation explaining the implementation's purpose and limitations.

Benefits of the Proposed Changes

  1. Improved Organization: The expanded structure separates specification content from supplementary materials, making the repository easier to navigate and clarifies the specification from other relevant artifacts.
  2. Enhanced Usability: The starting points in each folder lower the barrier for new contributors and provide clear examples for learning and development.

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