Skip to content

Conversation

@tg-x
Copy link
Collaborator

@tg-x tg-x commented Oct 18, 2024

  • Rename EngineFamily to EngineBehaviour
  • Improve ToC structure for engines
    • Move overview to main engine page, keeping the messages separate for better structure
  • Many small fixes for consistency (type names, page & section titles, etc)
  • Improved juvix imports usage
  • e.g. types.engines imports types.engines_* and types.anoma imports types.anoma_*, while types imports everything

@tg-x tg-x requested review from heindel and jonaprieto October 18, 2024 18:06
@tg-x tg-x changed the title separate template messages from overview Separate template messages from overview Oct 18, 2024
@github-actions
Copy link

github-actions bot commented Oct 18, 2024

Success! The preview of this PR will be available at https://anoma.github.io/nspec/pr-193/.

@tg-x tg-x force-pushed the tg-x/template-messages branch from 9d4aa92 to 80d5784 Compare October 18, 2024 18:24
@tg-x tg-x marked this pull request as draft October 29, 2024 13:43
@tg-x tg-x force-pushed the tg-x/template-messages branch from 20004c0 to fb01118 Compare October 29, 2024 13:48
@tg-x tg-x marked this pull request as ready for review October 29, 2024 17:10
@jonaprieto
Copy link
Collaborator

jonaprieto commented Oct 30, 2024

  • Separate template messages from overview for clarity and better overview (we also had it separate before in the old specs).

While your proposal is reasonable (separate messages from the overview page), I'd pass. We had a similar organisation of the templates as you proposed at some point. We, however, wanted to include the message types right into the eye on the engine's first page, similarly, as when opening docs from API documentation. Ultimately, messages are the first entry point for interacting with the engines.

  • Use Template Engine in the ToC to link to the overview, thus [[Template Engine]] wiki links lead to the right place.

Yes, this change would be good. Can we have it in another PR?

  • In everything.juvix.md only import top-level modules as the rest are already imported from those modules.
  • Simplify imports

I'd pass over this change. I don't expect anyone to import this module. It's for traceability. If we do as you say, the filename and everything else are meaningless.

Of course, if you intend to import definitions of an engine, your first one-go option is importing the base file, e.g., node_architecture.engines.ticker

@tg-x tg-x changed the title Separate template messages from overview Template improvements Oct 30, 2024
@tg-x tg-x force-pushed the tg-x/template-messages branch from aa5430d to d5b81bc Compare October 30, 2024 22:52
@tg-x tg-x marked this pull request as draft October 30, 2024 22:52
@jonaprieto jonaprieto marked this pull request as ready for review October 31, 2024 16:19
@jonaprieto jonaprieto merged commit 506a86a into v2 Oct 31, 2024
4 checks passed
@jonaprieto jonaprieto deleted the tg-x/template-messages branch October 31, 2024 16:24
jonaprieto added a commit that referenced this pull request Oct 31, 2024
commit 506a86a
Author: TG × ⊙ <*@tg-x.net>
Date:   Thu Oct 31 17:24:00 2024 +0100

    Template improvements (#193)

    - Rename `EngineFamily` to `EngineBehaviour`
    - Improve ToC structure for engines
    - Move overview to main engine page, keeping the messages separate for
    better structure
    - Many small fixes for consistency (type names, page & section titles,
    etc)
    - Improved juvix imports usage
    - e.g. types.engines imports types.engines_* and types.anoma imports
    types.anoma_*, while types imports everything

    ---------

    Co-authored-by: Jonathan Cubides <jonathan@heliax.dev>

commit 920678d
Author: Artem Gureev <67437331+agureev@users.noreply.github.com>
Date:   Fri Oct 25 23:52:55 2024 +0400

    Add Transparent RM Implementation Page (#198)

    Co-authored-by: Christopher Goes <cwgoes@pluranimity.org>
    Co-authored-by: Jonathan Cubides <jonathan.cubides@uib.no>

commit 1a0dad3
Author: Christopher Goes <cwgoes@pluranimity.org>
Date:   Fri Oct 25 18:50:37 2024 +0200

    Add skeleton for RM impls (#196)

    Add skeleton for RM implementation details (to be filled in by separate
    PRs).

    ---------

    Co-authored-by: Anoma Research <arts@heliax.dev>
    Co-authored-by: Jonathan Cubides <jonathan.cubides@uib.no>

commit 2e4026d
Author: D. Reusche <code@degregat.net>
Date:   Tue Oct 22 13:02:14 2024 +0200

    Add Intent Machine section (#191)

    Co-authored-by: Christopher Goes <cwgoes@pluranimity.org>

commit 0b6aca7
Author: Yulia Khalniyazova <yulia@heliax.dev>
Date:   Mon Oct 14 16:40:51 2024 +0200

    Clarify action definition (#171)

    Update the action definition and composition rules

commit fab01ac
Author: Jonathan Cubides <jonathan.cubides@uib.no>
Date:   Sat Oct 12 20:41:39 2024 -0500

    Fix broken links in system_architecture/identity/identity (#183)

    Fix the links in:

    -
    https://specs.anoma.net/pr-183/system_architecture/identity/identity.html

commit 29ad880
Author: Jonathan Cubides <jonathan.cubides@uib.no>
Date:   Sat Oct 12 14:12:45 2024 -0500

    Change typing:`Maybe` for `Option` and add a few helpers for action inputs (#181)

    - For better code readability, rename `Maybe` by `Option` and `just` and
    `nothing` by `some` and `none`, respectively
    - Refactor definitions according to the above changes
    - Add a few helper functions for optional-return functions, especially
    for engine actions.
    - Clean up a few imports

    ---------

    Co-authored-by: Anoma Research <arts@heliax.dev>

commit e464bf7
Author: TG × ⊙ <*@tg-x.net>
Date:   Sat Oct 12 06:16:16 2024 +0200

    Refactor basic, message, and mailbox types (#180)

    - replace `MessagePacket` & `EnvelopedMessage` with `EngineMessage` type
    - replace `MessageType` parameter with `Msg` type
    - add a few extra types (Commitment, MessageID, *Time, Version)
    - add cryptographic primitives
    - refactor: move all type defs under types/

    https://specs.anoma.net/pr-180/node_architecture/types/basics.html

    ---------

    Co-authored-by: Jonathan Cubides <jonathan.cubides@uib.no>
jonaprieto added a commit that referenced this pull request Oct 31, 2024
commit 506a86a
Author: TG × ⊙ <*@tg-x.net>
Date:   Thu Oct 31 17:24:00 2024 +0100

    Template improvements (#193)

    - Rename `EngineFamily` to `EngineBehaviour`
    - Improve ToC structure for engines
    - Move overview to main engine page, keeping the messages separate for
    better structure
    - Many small fixes for consistency (type names, page & section titles,
    etc)
    - Improved juvix imports usage
    - e.g. types.engines imports types.engines_* and types.anoma imports
    types.anoma_*, while types imports everything

    ---------

    Co-authored-by: Jonathan Cubides <jonathan@heliax.dev>

commit 920678d
Author: Artem Gureev <67437331+agureev@users.noreply.github.com>
Date:   Fri Oct 25 23:52:55 2024 +0400

    Add Transparent RM Implementation Page (#198)

    Co-authored-by: Christopher Goes <cwgoes@pluranimity.org>
    Co-authored-by: Jonathan Cubides <jonathan.cubides@uib.no>

commit 1a0dad3
Author: Christopher Goes <cwgoes@pluranimity.org>
Date:   Fri Oct 25 18:50:37 2024 +0200

    Add skeleton for RM impls (#196)

    Add skeleton for RM implementation details (to be filled in by separate
    PRs).

    ---------

    Co-authored-by: Anoma Research <arts@heliax.dev>
    Co-authored-by: Jonathan Cubides <jonathan.cubides@uib.no>

commit 2e4026d
Author: D. Reusche <code@degregat.net>
Date:   Tue Oct 22 13:02:14 2024 +0200

    Add Intent Machine section (#191)

    Co-authored-by: Christopher Goes <cwgoes@pluranimity.org>

commit 0b6aca7
Author: Yulia Khalniyazova <yulia@heliax.dev>
Date:   Mon Oct 14 16:40:51 2024 +0200

    Clarify action definition (#171)

    Update the action definition and composition rules

commit fab01ac
Author: Jonathan Cubides <jonathan.cubides@uib.no>
Date:   Sat Oct 12 20:41:39 2024 -0500

    Fix broken links in system_architecture/identity/identity (#183)

    Fix the links in:

    -
    https://specs.anoma.net/pr-183/system_architecture/identity/identity.html

commit 29ad880
Author: Jonathan Cubides <jonathan.cubides@uib.no>
Date:   Sat Oct 12 14:12:45 2024 -0500

    Change typing:`Maybe` for `Option` and add a few helpers for action inputs (#181)

    - For better code readability, rename `Maybe` by `Option` and `just` and
    `nothing` by `some` and `none`, respectively
    - Refactor definitions according to the above changes
    - Add a few helper functions for optional-return functions, especially
    for engine actions.
    - Clean up a few imports

    ---------

    Co-authored-by: Anoma Research <arts@heliax.dev>

commit e464bf7
Author: TG × ⊙ <*@tg-x.net>
Date:   Sat Oct 12 06:16:16 2024 +0200

    Refactor basic, message, and mailbox types (#180)

    - replace `MessagePacket` & `EnvelopedMessage` with `EngineMessage` type
    - replace `MessageType` parameter with `Msg` type
    - add a few extra types (Commitment, MessageID, *Time, Version)
    - add cryptographic primitives
    - refactor: move all type defs under types/

    https://specs.anoma.net/pr-180/node_architecture/types/basics.html

    ---------

    Co-authored-by: Jonathan Cubides <jonathan.cubides@uib.no>
@heindel heindel removed their request for review November 4, 2024 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants