Conversation
Signed-off-by: Rafael Belchior <rafael.belchior@tecnico.ulisboa.pt>
Signed-off-by: Rafael Belchior <rafael.belchior@tecnico.ulisboa.pt>
RafaelAPB
requested review from
AndreAugusto11,
LordKubaya,
VRamakrishna,
outSH and
sandeepnRES
as code owners
AndreAugusto11
left a comment
AndreAugusto11
left a comment
There was a problem hiding this comment.
This is amazing! Thank you very much! Exactly what we need now, to work on the documentation and ease the process of starting to interact with Cacti
There was a problem hiding this comment.
@RafaelAPB I would just suggest decreasing the font size wherever there are boxes on top of the letters
| --- | ||
| sequenceDiagram | ||
| participant App as Your App<br/>(Python/Java/Go) | ||
| participant API as Cacti API Server<br/>(Docker Container) |
There was a problem hiding this comment.
@RafaelAPB I think all cacti components (api server, connector plugin, and keychain plugin) would be within a single Docker Container, right? In that case, the "(Docker Container)" should not be just in the "Cacti API Server". Let me know your thoughts
| "@lerna-lite/version": "3.7.0", | ||
| "@openapitools/openapi-generator-cli": "2.13.1", | ||
| "@mermaid-js/mermaid-cli": "11.12.0", | ||
| "@openapitools/openapi-generator-cli": "2.7.0", |
There was a problem hiding this comment.
Is there any reason to downgrade the version of "openapitools/openapi-generator-cli?
| "watch": "run-p -r watch-*", | ||
| "build": "yarn build:dev && yarn build:prod", | ||
| "build:prod": "yarn build:prod:frontend", | ||
| "docs:diagrams": "mkdir -p docs/assets && echo 'Generating Getting Started guide diagrams (PNG)...' && bash -c 'for f in docs/docs/guides/diagrams/*.mmd; do name=$(basename \"$f\" .mmd); echo \" $name.png\"; mmdc -i \"$f\" -o \"docs/assets/$name.png\" -t default -b transparent -w 1920 -s 2; done' && echo 'All diagrams generated successfully'", |
There was a problem hiding this comment.
@RafaelAPB I would suggest removing the duplicate directory in docs/docs/guides/diagrams
| - [Level 1: Connector as a Library](#level-1-connector-as-a-library-lowest-immersion) | ||
| - [Level 2: API Server with Plugins](#level-2-api-server-with-plugins-medium-immersion) | ||
| - [Level 3: Full Framework Integration](#level-3-full-framework-integration-highest-immersion) | ||
| - [Deciding Which Level is Right for You](#deciding-which-level-is-right-for-you) |
There was a problem hiding this comment.
Is immersion the best way to describe this, maybe dept?
@AndreAugusto11, what do you think about this?
There was a problem hiding this comment.
@LordKubaya, I think it's just the internal label to the section
| | **Frontend** | `my-app-frontend/` - Your web UI | - | | ||
| | **Business Logic** | `my-app-business-logic-plugin/services/` | Plugin interface (`IPluginWebService`) | | ||
| | **REST Endpoints** | `my-app-business-logic-plugin/web-services/` | Endpoint registration helpers | | ||
| | **Smart Contracts** | `contracts/` - Your Solidity/chaincode | - | |
There was a problem hiding this comment.
Just call it chaincode, someone reading this for the first time will think that this is only for EVM-based ledgers.
3 participants
Pull Request Requirements
upstream/mainbranch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.-sflag when usinggit commitcommand. You may refer to this link for more information.Character Limit
A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.
Adds starting guide as per issue #862