{"id":20521528,"url":"https://github.com/iver-wharf/wharf-notes","last_synced_at":"2026-04-21T13:32:56.365Z","repository":{"id":50153249,"uuid":"370350952","full_name":"iver-wharf/wharf-notes","owner":"iver-wharf","description":"Architectural notes. No hard decisions, but instead notes from research and exploration","archived":false,"fork":false,"pushed_at":"2022-05-10T17:22:08.000Z","size":418,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-06T00:29:31.009Z","etag":null,"topics":["neuron","wharf"],"latest_commit_sha":null,"homepage":"https://wharf.iver.com/wharf-notes","language":"Markdown","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iver-wharf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"security-considerations-when-importing.md","support":null}},"created_at":"2021-05-24T12:52:26.000Z","updated_at":"2022-05-10T17:17:27.000Z","dependencies_parsed_at":"2022-08-26T13:40:38.040Z","dependency_job_id":null,"html_url":"https://github.com/iver-wharf/wharf-notes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"srid/neuron-template","purl":"pkg:github/iver-wharf/wharf-notes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iver-wharf%2Fwharf-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iver-wharf%2Fwharf-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iver-wharf%2Fwharf-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iver-wharf%2Fwharf-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iver-wharf","download_url":"https://codeload.github.com/iver-wharf/wharf-notes/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iver-wharf%2Fwharf-notes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32094481,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T11:25:29.218Z","status":"ssl_error","status_checked_at":"2026-04-21T11:25:28.499Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["neuron","wharf"],"created_at":"2024-11-15T22:29:41.669Z","updated_at":"2026-04-21T13:32:56.346Z","avatar_url":"https://github.com/iver-wharf.png","language":"Markdown","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wharf architecture\n\nThis repo contains notes about the architecture. The ones that are unfinished\nwill be found under the `stub` directory.\n\nWe're using [neuron](https://github.com/srid/neuron) for this to turn it into\na web page with HTML files instead of markdown files.\n\n## Reading: \u003chttps://wharf.iver.com/wharf-notes\u003e\n\nAll commits to `master` are deployed there using GitHub pages.\n\n## Writing\n\nRecommended to use an editor plugin for this. Check the neuron documentation\nfor [Editor integration](https://neuron.zettel.page/editor.html) for more info.\n\nFor comtributors/maintainers with write access to this repo: It's OK to push to\n`master` here, as it's mostly used to keep temporary/draft/stub notes.\n\n## Running\n\n### Running via docker\n\n\u003e This will watch the files for changes, but will not automatically refresh your\n\u003e browser. You'll have to refresh the page manually.\n\n```sh\ndocker run --rm -it -p 8080 -v $(pwd):/notes sridca/neuron neuron rib -Sw\n```\n\n### Running via neuron\n\nYou can run it locally and have it hosted as a web page to see it rendered.\n\n1. Install neuron: \u003chttps://neuron.zettel.page/install.html\u003e\n\n2. Run the `rib` subcommand to generate and host the files on localhost:8080\n\n   \u003e This will watch the files for changes, but will not automatically refresh your\n   \u003e browser. You'll have to refresh the page manually.\n\n   ```sh\n   # -S makes it host at localhost:8080\n   # -w makes it watch for changes and automatically regenerate\n   neuron rib -Sw\n   ```\n\n3. Visit \u003chttp://localhost:8080\u003e\n\n## Building\n\n### Building docker image\n\n```sh\ndocker build -t wharf-notes .\n\ndocker run --rm -it -p 8080:8080 wharf-notes\n```\n\n### Building via neuron\n\nYou can also just generate the files and then host it via for example nginx.\n\n1. Install neuron: \u003chttps://neuron.zettel.page/install.html\u003e\n\n2. Run the `rib` subcommand, but without any arguments\n\n   ```sh\n   neuron rib\n   ```\n\n3. Publish the files found in `.neuron/output`\n\n---\n\nMaintained by [Iver](https://www.iver.com/en).\nLicensed under the [MIT license](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiver-wharf%2Fwharf-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiver-wharf%2Fwharf-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiver-wharf%2Fwharf-notes/lists"}