Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Obsidian-based documentation system #213

Merged
merged 10 commits into from
Jul 3, 2024
Merged

Obsidian-based documentation system #213

merged 10 commits into from
Jul 3, 2024

Conversation

davenquinn
Copy link
Member

@davenquinn davenquinn commented Jun 1, 2024

Created a documentation system based on WikiLinks and designed for baseline compatibility with Obsidian and VSCode's "Foam" knowledge management systems. The core addition here is a Markdown engine that can parse WikiLinks (e.g. [[page]]) and a site-map tool that can resolve them.

This is based on code created for the DigitalCrust website last fall. We'll eventually update this into a module that can be shared between both systems.

The new docs system exists at /dev/docs. We have not yet merged with the existing draft documentation. One particular problem to solve is our orientation towards MDX.

This is a continuation of our quest for a good approach to documentation outlined in #109.

davenquinn added 10 commits May 30, 2024 03:51
* main: (151 commits)
  Created a small script to set repository configuration
  Major improvements to correlation diagrams
  merged correctly
  test
  fixed yarn lock
  moved around
  added new links
  locations changes
  merged with start
  Added gap-bound packages
  Updated correlation diagram
  Removed unused label
  Slightly simplified
  Duplicated components for scale
  Starting point to separate scale
  Hoisted some data fetching
  Updated column types
  Brought column module into the system
  Made everything more compact
  Updated column colors
  ...
@davenquinn davenquinn merged commit 05788cc into main Jul 3, 2024
1 check passed
@davenquinn davenquinn deleted the obsidian-docs branch July 3, 2024 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant