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

Added some more links and attribution

Browse source
This commit is contained in:
Igor Támara 2025-10-07 16:40:03 -05:00 • committed by CJ van den Berg
parent 4e45ce1b00
commit 5d6c36a4e3
2 changed files with 23 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

20
content/docs/architecture.smd
View file

@ -1,7 +1,7 @@
--- ---
.title = "Architecture", .title = "Architecture",
.date = @date("2025-07-06T00:00:00"), .date = @date("2025-07-06T00:00:00"),
.author = "CJ van den Berg", .author = "Igor Támara",
.layout = "index.shtml", .layout = "index.shtml",
.draft = false, .draft = false,
--- ---
@ -11,9 +11,12 @@ understand how the code is organized and where to look at when starting
to contribute developing Flow Control. Make sure you have read to contribute developing Flow Control. Make sure you have read
first [help.md](https://github.com/neurocyte/flow/blob/master/help.md) first [help.md](https://github.com/neurocyte/flow/blob/master/help.md)
and use the editor at least in flow mode. We recommend reading the and use the editor at least in flow mode. We recommend reading the
[deepwiki description](https://deepwiki.com/neurocyte/flow) and join [deepwiki description](https://deepwiki.com/neurocyte/flow) for a more
in depth documentation and joining
[Discord](https://discord.com/invite/4wvteUPphx) to ask from the [Discord](https://discord.com/invite/4wvteUPphx) to ask from the
simplest. simplest. If something does not look accurate on this documentation or
in deepwiki. Do not hesitate to ask in the channels and open a PR to
improve anything.
## Internals ## Internals
@ -58,8 +61,9 @@ through a set of `_views` (i.e. `logview`, `inputview`,
## Operating systems and UI ## Operating systems and UI
libvaxis is in charge of rendering the text and all the interface in [libvaxis](https://github.com/rockorager/libvaxis) is in charge of
Linux, MacOS, FreeBSD, while in Windows there is an special GUI. rendering the text and all the interface in Linux, MacOS, FreeBSD,
while in Windows there is an special GUI.
## Communication between components ## Communication between components
@ -67,8 +71,8 @@ Linux, MacOS, FreeBSD, while in Windows there is an special GUI.
sending messages between different flow components, for example, sending messages between different flow components, for example,
when a widget needs updating information from changing states of when a widget needs updating information from changing states of
internal data and when components or external processes take internal data and when components or external processes take
time, for example, tree-sitter queries to highlight the current time. For example, tree-sitter queries to highlight the current
file, of a particular language, LSPs, git, running a `shell` file of a particular language, LSPs, git, running a `shell`
command via a `task`. command via a `task`.
## Programming languages ## Programming languages
@ -85,4 +89,4 @@ actions that ease developing Flow itself and also are used to offer
feedback via `logview`. feedback via `logview`.
You can find [contributing guidelines](/docs/contributing). We have some [contribution guidelines](/docs/contributing).

17
content/docs/contributing.smd
View file

@ -1,7 +1,7 @@
--- ---
.title = "Contributing", .title = "Contributing",
.date = @date("2025-07-06T00:00:00"), .date = @date("2025-07-06T00:00:00"),
.author = "CJ van den Berg", .author = "Igor Támara",
.layout = "index.shtml", .layout = "index.shtml",
.draft = false, .draft = false,
--- ---
@ -33,8 +33,9 @@ is a good way to contribute. When reporting one, it should contain:
* Any other information, like screenshots, video, screencast, the * Any other information, like screenshots, video, screencast, the
platform allows to add that information. platform allows to add that information.
Issues later on are tagged with proposed version to solve it, in case it's a Issues later on are tagged with proposed version to solve them, in case
low hanging fruit, it's possible that it can be solved pretty quick. it's a low hanging fruit, it's possible that it can be solved pretty
quick.
Spreading the word is another way to contribute to Flow Code growth. Spreading the word is another way to contribute to Flow Code growth.
@ -45,7 +46,7 @@ Spreading the word is another way to contribute to Flow Code growth.
[Fork](https://github.com/neurocyte/flow/fork), no worries, if you [Fork](https://github.com/neurocyte/flow/fork), no worries, if you
happen to use [codeberg](https://codeberg.org/neurocyte/flow), or happen to use [codeberg](https://codeberg.org/neurocyte/flow), or
[sourcehot](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 Discussing via [Discord](https://discord.com/invite/4wvteUPphx) is a good
@ -62,7 +63,12 @@ follow the codebase.
Please follow what you see in the source code for functions, Structs, Please follow what you see in the source code for functions, Structs,
variables, const names, etc... Functions have descriptive names to 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. 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
issue or jump in [Discourse to comment](https://discord.com/invite/4wvteUPphx)
and comment.
### Testing ### Testing
@ -72,7 +78,6 @@ opportunity to generate regressions.
## Getting in touch. ## Getting in touch.
[Discord](https://discord.com/invite/4wvteUPphx) and [Discord](https://discord.com/invite/4wvteUPphx) and
[Github issues](https://github.com/neurocyte/flow/issues) are the [Github issues](https://github.com/neurocyte/flow/issues) are the
main channels to do so. main channels to do so.