Contributing

How to contribute

Sign in with your GitHub account.
Create or edit notes using the built-in editor. Edit notes by simply clicking on one, or create one using the button at the top left. You can edit many notes in one session.
Review your changes on the review page. This is accessed via the button at the top left.
Submit - this will be reviewed by the core team and merged if accepted.

All content lives as markdown files with tags and properties. The editor validates your changes against the schemas below.

Wikilinks

Link to other notes with [[Note Name]]. Embed notes with ![[Note Name]]. Embed images with ![[image.png]]. Use these when you mention another existing or future note.

Hierarchy

Use parent to declare a strict subset relationship (all points must exist within the parent's region). Use inherit for the same ancestry rules without requiring point overlap.

Both support boolean tree syntax for case constraint logic:

# Union (default): exists in both years
inherit:
  - '[[2018]]'
  - '[[2019]]'

# Intersection: narrows constraints
inherit:
  - and:
    - '[[CB-type long antenna]]'
    - '[[2015]]'

Schema

Document

Defined by the #document tag.

`author`: string

Author of a document.

`source`: string | null

Source for a document (e.g. https://plonkit.net).

`version`: string

Version of a document (e.g. 1.0.0).

`level?`: string

Difficulty level of the document.

One of: beginner, intermediate, advanced, expert.

`cover?`: string

Cover image path.

Meta

Defined by the #meta tag. #meta is the root, and all children categories like #meta/irl/building or #meta/antenna are applicable.

`reliability`: number | null

1-5 range of how reliable a meta is to use (1 lowest, 5 highest).

`author`: string | null

The author of a meta, if any.

`yield`: number

1-5 range of how useful a meta is (1 is least useful, 5 is most useful).

`abstraction`: number

1-5 range of how abstract a meta is (1 least abstract e.g. irl, 5 most abstract e.g. car meta).

`region_template?`: string

Controls how the region shape is rendered.

region_template: "local"  # or "default", "tight", "loose"

local for metas that are granularly mapped or specific to a location. default for most other metas. tight and loose adjust the buffer around points.

`region?`: string

Path to a region file; either a JSON file in MMA format or a GeoJSON of a single feature.

region: "regions/my-meta.json"

`parent?`: array | string

Declares a strict subset relationship -- all points must exist within the parent's region. See hierarchy.

# Single parent
parent: '[[A-type long antenna]]'

# Multiple parents (OR)
parent:
  - '[[2015]]'
  - '[[2016]]'

`inherit?`: array | string

Like parent but does NOT require points to overlap. Carries exclusion rules down the ancestry tree. See hierarchy.

inherit:
  - '[[CB-type long antenna]]'
  - '[[2018]]'

`case?`: object

Temporal constraints filtered via the map's date picker. The date field is a [start, end] range in ISO format.

case:
  date:
    - 2015-01-01
    - 2015-12-31

`colors?`: object

Color overrides for map rendering, keyed by tag category.

colors:
  tag:
    red: "#c02739"

Tip

Defined by the #tip tag.

`author?`: string

Author of a tip.

Index

Defined by the #index tag.