MD Layout Template

This is a foundational template for generating markdown files using an LLM-driven workflow.

Directory Structure & Workflow

The structure is designed to be understood by an LLM, outlining a clear process from prompt to final output.

• /src:

  • Purpose: Contains the source prompts and conversations with the AI.
  • Workflow: Each file in this directory is a prompt that results in a corresponding file in the /build directory. For example, the prompt src/new_idea.prompt.md will generate build/new_idea.md.

• /template:

  • Purpose: Stores markdown templates.
  • Workflow: These are boilerplate structures that the LLM can use and populate during the generation process, based on instructions from a prompt in /src.

• /tools:

  • Purpose: Holds configuration files, specific instructions, or reusable rule sets.
  • Workflow: These files guide the LLM's behavior, ensuring consistency and adherence to specific formats or methodologies.
  • /core: A sub-directory for storing commonly used, essential tools and scripts.
    • combicode_README.md: This file provides instructions for the LLM on how to combine multiple markdown files into a single, coherent document. It defines the rules for merging, ordering, and formatting.

• /build:

  • Purpose: The output directory for all generated markdown files.
  • Workflow: This folder contains the final results of the generation process. It should not be edited manually.

• /logs:

  • Purpose: Records the metadata of the generation process.
  • Workflow: Logs are named using a precise timestamp and a user-defined title, generated by a Windows OS command.
  • Naming Convention: Log files must be named YYYY-MM-DD-HH-MM-title.txt.
  • Windows OS Command: To generate the filename and create the log file, use the following commands. Remember to replace "your-log-title" with the actual title.

    set "title=your-log-title"
    for /f "tokens=2 delims==" %%I in ('wmic os get localdatetime /format:list') do set datetime=%%I
    set filename=%datetime:~0,4%-%datetime:~4,2%-%datetime:~6,2%-%datetime:~8,2%-%datetime:~10,2%-%title%.txt
    echo. > logs\%filename%

LLM Interpretation Flow

1. Input: A prompt file from /src is the primary input.
2. Resources: The LLM utilizes files from /template for structure and /tools for configuration and rules.
3. Output: The final, generated markdown file is saved in /build.
4. Logging: The operation's metadata is recorded in /logs.