neurocyte/flow-website
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Add footer to invite others to fix if needed

Browse source
This commit is contained in:
Igor Támara 2025-10-18 21:27:45 -05:00 • committed by CJ van den Berg
parent 570f86bf85
commit 9fd1e1f763
3 changed files with 29 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

15
content/docs/architecture.smd
View file

@ -2,8 +2,9 @@
.title = "Architecture", .title = "Architecture",
.date = @date("2025-07-06T00:00:00"), .date = @date("2025-07-06T00:00:00"),
.author = "Igor Támara", .author = "Igor Támara",
.layout = "index.shtml", .layout = "tutorial.shtml",
.draft = false, .draft = false,
.custom = { .githubedit = "https://github.com/neurocyte/flow-website/tree/master/content/docs/architecture.smd"},
--- ---
This document describes in a general way, concepts that help to This document describes in a general way, concepts that help to
@ -68,12 +69,12 @@ while in Windows there is an special GUI.
## Communication between components ## Communication between components
[Thespian](https://github.com/neurocyte/thespian) is in charge of [Thespian](https://github.com/neurocyte/thespian) is in charge of
sending messages between different flow components, for example, processes synchronization and allows sending messages between
when a widget needs updating information from changing states of different flow components, for example, when a widget needs
internal data and when components or external processes take updating information from changing states of internal data and
time. For example, tree-sitter queries to highlight the current when components or external processes take time. For example,
file of a particular language, LSPs, git, running a `shell` tree-sitter queries to highlight the current file of a particular
command via a `task`. language, LSPs, git, running a `shell` command via a `task`.
## Programming languages support ## Programming languages support

19
content/docs/contributing.smd
View file

@ -2,11 +2,11 @@
.title = "Contributing", .title = "Contributing",
.date = @date("2025-07-06T00:00:00"), .date = @date("2025-07-06T00:00:00"),
.author = "Igor Támara", .author = "Igor Támara",
.layout = "index.shtml", .layout = "tutorial.shtml",
.draft = false, .draft = false,
.custom = { .githubedit = "https://github.com/neurocyte/flow-website/tree/master/content/docs/contributing.smd"},
--- ---
## Asking for a feature ## Asking for a feature
Please [open an issue](https://github.com/neurocyte/flow/issues) that Please [open an issue](https://github.com/neurocyte/flow/issues) that
@ -27,7 +27,7 @@ some guidance. [Reporting a bug](https://github.com/neurocyte/flow/issues)
is a good way to contribute. When reporting one, it should contain: is a good way to contribute. When reporting one, it should contain:
* Flow version. You get it with `flow --version` * Flow version. You get it with `flow --version`
* What you were doing, if possible step, by step to reproduce it * What you were doing, if possible, step by step to reproduce it
* What actually happened * What actually happened
* What was expecting to happen * What was expecting to happen
* Any other information, like screenshots, video, screencast, the * Any other information, like screenshots, video, screencast, the
@ -49,9 +49,9 @@ happen to use [codeberg](https://codeberg.org/neurocyte/flow), or
[sourcehut](https://git.sr.ht/~neurocyte/flow), it's possible to [sourcehut](https://git.sr.ht/~neurocyte/flow), it's possible to
fork and contribute via those services too. fork and contribute via those services too.
Discussing via [Discord](https://discord.com/invite/4wvteUPphx) is a good Using [Discord](https://discord.com/invite/4wvteUPphx) is a good
start to talk about what you are about to offer, or if you decide to pick starting point to discuss about what you are about to offer, or if
an open issue, is a good practice first opening an issue and you decide to pick an open issue, is a good practice first
commenting in one of the channels to get some feedback and get to commenting in one of the channels to get some feedback and get to
agreements or find guidance. agreements or find guidance.
@ -65,10 +65,11 @@ variables, const names, etc... Functions have descriptive names to
use less time adding and maintaining comments to communicate the use less time adding and maintaining comments to communicate the
purpose and intent. Don't worry about commenting each function, module purpose and intent. Don't worry about commenting each function, module
or parameter, there are automated tools that are currently helping or parameter, there are automated tools that are currently helping
with this, take a peek on [deepwiki](https://deepwiki.com/neurocyte/flow), with this, take a peek on [deepwiki](https://deepwiki.com/neurocyte/flow);
if you find something inaccurate in those docs or others, do open an if you find something inaccurate in this doc or others, do open an
issue or jump in [Discord](https://discord.com/invite/4wvteUPphx) issue or jump in [Discord](https://discord.com/invite/4wvteUPphx)
and comment. and comment, it's valid to
[improve too](https://github.com/neurocyte/flow-website/tree/master/content/docs/contributing.smd").
### Commit comments ### Commit comments

11
layouts/tutorial.shtml Normal file
View file

@ -0,0 +1,11 @@
<extend template="base.shtml">
<head id="head">
</head>
<body id="body">
<h1 :text="$page.title"></h1>
<div :html="$page.content()"></div>
<hr>
<p>If you find anything that could be better, because it does not reflect
what happens with flow or can be explain better, don't hesitate to
<a href="$page.custom.getOr('githubedit', 'https://github.com/neurocyte/flow-website/')">improve me</a>.</p>
</body>