FAQ and Known Limits

FAQ and Known Limits

This page answers common questions and lists what Waymark does not do yet. Back to the README.

Questions

• Does it write anything to my forges? No. Every call is a read.
• What does it store? Only /data/state.json and the last good copies of the projects and ideas files.
• GitLab, Bitbucket, several Docker hosts, sign-in, notifications? Not in this version.
• Does it need JavaScript? No. Every page reads the same without it; the scripts only add to it. The project board's filters and the ideas' kind and size filters work without it. Search, the theme button, Surprise me and live updates need it.

Things that trip people up

• Label ideas come from each repo's 10 newest open issues, the ones Waymark already reads. On a busy repo an older labelled issue does not show.
• Quote the ideas marker in YAML: marker: "waymark-idea:". An unquoted value ending in : fails to load.
• ${VAR} expands only in string fields. heatmap: ${H} fails to load, and in flow style quote the value: {token: "${T}"}.
• Notes markers right after Markdown punctuation (**@me**, (@me)) do not match.
• Notes symlinks that leave the notes folder, and absolute symlinks, are not followed. Files over 1 MiB are skipped.
• Plans need a date at the start of the file or folder name.

Known limits

• One slow forge delays the others' refresh: they are read in one cycle, though each call is bounded by its timeout.
• Forks of other people's repos become projects; hide them with hide_repos in a projects file.
• Homepage probes do not refuse NAT64, benchmarking or other reserved ranges; they report only up or down and the latency.
• A forge that has not listed its repos (a wrong token, or offline) holds back new events for up to 10 minutes after start.