---
# System prepended metadata

title: Document Organization and Tags
tags: [Proposed, Meta]

---

# Document Organization and Tags

This document proposes a scheme for organizing and categorizing documents in the Bevy HackMD.

When browsing for documents, generally there are three things we want to know:

* **Subject Area** (ECS, Rendering, UI, and so on)
* **Purpose** (RFC, Reference, etc.)
* **Status** (Proposed, Accepted, etc.)

Here are the specific guidelines:

* The document's **subject area** and **status** will be indicated by **tags**.
* The document's **purpose** will be grouped using HackMD folders. For example, RFCs will live in the "RFCs" folder.

The reason for doing it this way is that:
* a document may have more than one subject area (ECS + Rendering) so folders aren't appropriate
* Status can change several times over the lifetime of a document, so a tag is appropriate
* mixing documents with difference purposes can be confusing - for example a folder containing both end-user documentation and RFCs mixed together will be hard to navigate, even if they share a topic.

**The tags for subject area** will be the same as the Github `A-` tags, but without the `A-` prefix.

The tags for status will be:
* **Proposed** - meaning document is ready for people to look at.
* **Exploring** - means that the Bevy maintainers have acknowledged that this is an issue worth considering, and may involve a working group.
* **Accepted** - means that we have achieved consensus on this issue and are ready to move towards implementation.
* **Rejected** - means that we have decided not to move forward with this proposal. Note that rejected documents can be extremely valuable as a written record of why we decided not to pursue a particular path.
* **Completed** - the proposal was successfully implemented.

