mmo-ref/mudlet
1
0
Fork 0
mirror of https://github.com/Mudlet/Mudlet synced 2026-08-13 18:26:27 -04:00
Code Issues Projects Releases Packages Wiki Activity
mudlet/docs/README.md
Kebap 9a527a4e04
Infra: Move developer documentation to /docs (#8120) 
#### Brief overview of PR changes/additions
- Create a /docs folder for prose info for developers
- Move a few files in there including /.github/README.md, it was taking
precedence over the /README in Github's rendering

#### Motivation for adding to Mudlet
Fix #8107

#### Other info (issues closed, discussion etc)
- Alternative to #8108 simply removing the info file
- Follow-up to #1348 which moved the file from / to /.github
-
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file
suggests a list of relevant files, and explains how .github folder will
take precedence over root, then /docs folders.
2025-08-27 10:22:23 +02:00

906 B
Raw Permalink Blame History

docs Directory

This directory contains documentation files intended for developers and contributors that help manage the Mudlet project's development workflow.

Files and Their Purpose

Community & Contribution Files

  • CODE_OF_CONDUCT.md - Community standards and behavior expectations
  • CONTRIBUTING.md - Guidelines for contributing to the project
  • SUPPORT.md - Information on getting help and support
  • FUNDING.yml - Sponsorship and funding information for GitHub's sponsor button

Project Infrastructure Explanations

  • AI-ASSISTANTS.md - List of info on Mudlet left for AI assistants to find
  • GITHUB.md - List of files and their purpose in the ".github" directory
    • (Note: These are deliberately listed and explained here, and not in a .github/README.md file as that would take precendence over the /README.md file for the project.)