From 5d6c36a4e3f5a417fede81c1963ae04f6a299f19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20T=C3=A1mara?= Date: Tue, 7 Oct 2025 16:40:03 -0500 Subject: [PATCH] Added some more links and attribution --- content/docs/architecture.smd | 20 ++++++++++++-------- content/docs/contributing.smd | 17 +++++++++++------ 2 files changed, 23 insertions(+), 14 deletions(-) diff --git a/content/docs/architecture.smd b/content/docs/architecture.smd index f2d9e0e..d320069 100644 --- a/content/docs/architecture.smd +++ b/content/docs/architecture.smd @@ -1,7 +1,7 @@ --- .title = "Architecture", .date = @date("2025-07-06T00:00:00"), -.author = "CJ van den Berg", +.author = "Igor Támara", .layout = "index.shtml", .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 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 -[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 -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 @@ -58,8 +61,9 @@ through a set of `_views` (i.e. `logview`, `inputview`, ## Operating systems and UI -libvaxis is in charge of rendering the text and all the interface in -Linux, MacOS, FreeBSD, while in Windows there is an special GUI. +[libvaxis](https://github.com/rockorager/libvaxis) is in charge of +rendering the text and all the interface in Linux, MacOS, FreeBSD, +while in Windows there is an special GUI. ## 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, 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` +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 @@ -85,4 +89,4 @@ actions that ease developing Flow itself and also are used to offer feedback via `logview`. -You can find [contributing guidelines](/docs/contributing). \ No newline at end of file +We have some [contribution guidelines](/docs/contributing). \ No newline at end of file diff --git a/content/docs/contributing.smd b/content/docs/contributing.smd index 3aeacd0..f7a6c7f 100644 --- a/content/docs/contributing.smd +++ b/content/docs/contributing.smd @@ -1,7 +1,7 @@ --- .title = "Contributing", .date = @date("2025-07-06T00:00:00"), -.author = "CJ van den Berg", +.author = "Igor Támara", .layout = "index.shtml", .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 platform allows to add that information. -Issues later on are tagged with proposed version to solve it, in case it's a -low hanging fruit, it's possible that it can be solved pretty quick. +Issues later on are tagged with proposed version to solve them, in case +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. @@ -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 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. 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, variables, const names, etc... Functions have descriptive names to 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 @@ -72,7 +78,6 @@ opportunity to generate regressions. ## Getting in touch. - [Discord](https://discord.com/invite/4wvteUPphx) and [Github issues](https://github.com/neurocyte/flow/issues) are the main channels to do so.