Skip to content

Commit

Permalink
Better headings in v4.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SkepticMystic committed Feb 3, 2024
1 parent e0df9ed commit d9f3d99
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions V4.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,21 @@ V4 is a complete rewrite of the plugin. As a result:
- Most features have been reimplimented with backwards-compatiable behaviour.
- There are also some breaking changes (marked with "⚠️").

## Fundamental Changes
## Usage

You can start using V4 right now by installing it with the BRAT plugin

> [!warning] Your Breadcrumbs settings will be migrated to the new format.
> Features that have already been reimplemented will retain their old settings. But missing features will lose their settings.
## Changes

### Foundational Changes

- Nodes are added to the graph using their full path, not just their basename. This fixes issue: TODO
- Implied relationships are customizable per-Hierarchy, not just globally. This resolves: TODO

## Features
### Features

Legend:

Expand All @@ -20,7 +29,7 @@ Legend:
- ❌: Removed, don't plan to implement.
- ❔: Undecided for now.

### Graph Builders
#### Graph Builders

Previously referred to as "Alternative Hierarchies", these are the various ways to add edges to the Breadcrumbs graph.

Expand All @@ -35,12 +44,12 @@ Previously referred to as "Alternative Hierarchies", these are the various ways
- ❔ Regex notes
- ❔ Traverse notes

### Commands
#### Commands

- ✅ Create index from note (and copy to clipboard)
- ⌚ Write Breadcrumbs to file

### Views
#### Views

- ✅ Matrix view
- ✅ Grid view
Expand All @@ -51,15 +60,15 @@ Previously referred to as "Alternative Hierarchies", these are the various ways
- ❔ Ducks view
- ❔ Tree view

### Codeblocks
#### Codeblocks

- ✅ Implemented

### API
#### API

- ❔ Probably

## Breaking Changes ⚠️
#### Breaking Changes ⚠️

- The `BC-tag-note` field is now called `BC-tag-note-tag`.
- You will be notified if any notes use the old syntax, so you can change them.
Expand Down

0 comments on commit d9f3d99

Please sign in to comment.