lore/wh40k-warpborn
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
wh40k-warpborn/.copilot/documentation-guidelines.md
Merith 5236b5c554 switch to gemini
2025-07-17 00:15:34 -07:00

2.7 KiB
Raw Blame History

Documentation and Lore Management Guidelines

This document outlines the rules and procedures for updating, expanding, or modifying the lore for the Echo Legion. Adhering to these guidelines ensures that the project remains consistent, organized, and traceable to its original concepts.

Core Principles

  1. Preserve Original Intent: All changes must respect the core concepts laid out in .copilot/original-import.md. No new lore should contradict established facts without a strong, documented reason.
  2. Maintain Traceability: Every significant piece of information must be traceable back to its source.
  3. Ensure Consistency: The entire body of lore must remain internally consistent. A change in one document may require updates in others.

The Workflow for Changes

  1. Consult the Quick Reference: Before making any change, consult .copilot/original-import-quick-reference.md to understand the original context and where the concept is referenced.
  2. Edit or Add Content: Make the necessary changes to the relevant markdown file(s) in the lore/, military/, society/, or technology/ directories.
  3. Add/Update Traceability Comments: Insert or update a hidden HTML comment (<!-- ... -->) near the modified text, referencing the relevant line number(s) from original-import.md.
    • Example: <!-- Original import: Lines 45-49 describe the armor's origins -->
  4. Update the Quick Reference (If Necessary): If a major new concept is introduced or an existing one is significantly altered, update the .copilot/original-import-quick-reference.md to reflect this.
  5. Update the Development Log: Briefly note the change in .copilot/development-log.md to maintain a running history of the project's evolution.

File Structure Overview

  • README.md: Master index. Should only contain high-level summaries and links.
  • lore/: Contains the history and narrative of the faction.
  • military/: Contains all information related to the faction's armed forces.
  • society/: Contains details on culture, philosophy, and characters.
  • technology/: Contains specifics on equipment, STCs, and manufacturing.
  • .copilot/: Contains all meta-files for project management.
    • original-import.md: The read-only source material. DO NOT EDIT.
    • original-import-quick-reference.md: The primary tool for validation.
    • development-log.md: A log of all major changes and decisions.
    • faction-reference.md: A quick cheat-sheet for names, terms, and core ideas.
    • documentation-guidelines.md: This file.

This system was established to ensure long-term project health and clarity. Follow it rigorously.