diff --git a/content/docs/architecture.smd b/content/docs/architecture.smd index 3304cad..b0e2658 100644 --- a/content/docs/architecture.smd +++ b/content/docs/architecture.smd @@ -2,8 +2,9 @@ .title = "Architecture", .date = @date("2025-07-06T00:00:00"), .author = "Igor Támara", -.layout = "index.shtml", +.layout = "tutorial.shtml", .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 @@ -68,12 +69,12 @@ while in Windows there is an special GUI. ## Communication between components [Thespian](https://github.com/neurocyte/thespian) is in charge of -sending messages between different flow components, for example, -when a widget needs updating information from changing states of -internal data and when components or external processes take -time. For example, tree-sitter queries to highlight the current -file of a particular language, LSPs, git, running a `shell` -command via a `task`. +processes synchronization and allows sending messages between +different flow components, for example, when a widget needs +updating information from changing states of internal data and +when components or external processes take time. For example, +tree-sitter queries to highlight the current file of a particular +language, LSPs, git, running a `shell` command via a `task`. ## Programming languages support diff --git a/content/docs/contributing.smd b/content/docs/contributing.smd index 6a5ca8e..5ee9de7 100644 --- a/content/docs/contributing.smd +++ b/content/docs/contributing.smd @@ -2,11 +2,11 @@ .title = "Contributing", .date = @date("2025-07-06T00:00:00"), .author = "Igor Támara", -.layout = "index.shtml", +.layout = "tutorial.shtml", .draft = false, +.custom = { .githubedit = "https://github.com/neurocyte/flow-website/tree/master/content/docs/contributing.smd"}, --- - ## Asking for a feature 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: * 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 was expecting to happen * 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 fork and contribute via those services too. -Discussing via [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 -an open issue, is a good practice first opening an issue and +Using [Discord](https://discord.com/invite/4wvteUPphx) is a good +starting point to discuss about what you are about to offer, or if +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 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 purpose and intent. Don't worry about commenting each function, module or parameter, there are automated tools that are currently helping -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 +with this, take a peek on [deepwiki](https://deepwiki.com/neurocyte/flow); +if you find something inaccurate in this doc or others, do open an 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 diff --git a/layouts/tutorial.shtml b/layouts/tutorial.shtml new file mode 100644 index 0000000..77da689 --- /dev/null +++ b/layouts/tutorial.shtml @@ -0,0 +1,11 @@ + + + + +

+
+
+

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 + improve me.

+ \ No newline at end of file