Skip to content

Commit

Permalink
outline metadata management and virtual filesystem docs
Browse files Browse the repository at this point in the history
  • Loading branch information
azuline committed Oct 26, 2023
1 parent d084623 commit ce21552
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 8 deletions.
24 changes: 16 additions & 8 deletions docs/METADATA_MANAGEMENT.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
# Managing Your Music Metadata

## Data Querying
TODO Intro: motivations, reasons, fields we care about

There are several commands that print out data from the read cache in a
JSON-encoded format (e.g. `rose releases print` and `rose collages print`). The
command output can be piped into tools like `jq`, `fx`, and others.

## Tagging Conventions
## Tag Conventions

Rosé is lenient in the tags it ingests, but has opinionated conventions for the
tags it writes.
tags it writes. Impl detail: how exactly does rose edit the files?

### Fields
### Field Mappings

TODO

Expand Down Expand Up @@ -39,3 +35,15 @@ The artist tag is described by the following grammar:
<producer> ::= ' produced by ' <name>
<name> ::= string ';' <name> | string
```

## Manual Editing

TODO: Text file editing

## Metadata Import & Cover Downloading

TBD

## Rules Engine

TBD
20 changes: 20 additions & 0 deletions docs/VIRTUAL_FILESYSTEM.md
Original file line number Diff line number Diff line change
@@ -1 +1,21 @@
# Browsing the Virtual Filesystem

TODO: Intro??

## Mounting & Unmounting

troubleshooting... edge cases

## Directory Structure

## Directory and File Names

## New Releases

## Operations

> [!NOTE]
> Operations on collages and playlists are documented in
> [Using Playlists & Collages](./PLAYLISTS_COLLAGES.md).
Where can I write? What can I rename?

0 comments on commit ce21552

Please sign in to comment.