Diagram Contract Model - Githubissues

accordproject / techdocs

Accord Project Documentation

Apache License 2.0

61 stars 134 forks source link

Diagram Contract Model #275

Open jolanglinais opened 4 years ago

jolanglinais commented 4 years ago

We should capture this diagram, or one like it, in our documentation. This is from our slide deck template.

Jigyasa-Kumari commented 4 years ago

Hi @irmerk could you explain this issue a little more in detail? I would like to contribute to this issue

jeromesimeon commented 4 years ago

@Jigyasa-Kumari It would be nice to have the latest version of the document include some of the information that used to be in https://docs.accordproject.org/docs/0.13/spec-concepts.html

It could be as a new section, or integrated in an existing section.

Jigyasa-Kumari commented 4 years ago

In your contributing section, it says that to update documentation, changes need to be made to the source code. I am not sure about where exactly I need to make the changes. Could you please direct me regarding this?

Nipunagg commented 4 years ago

Is this above issue is regarding the updation of documentation by using the Tech-Agnostic diagram

somnathPrasad commented 3 years ago

Hey, is this issue open. I would like to contribute.

jeromesimeon commented 3 years ago

Hey, is this issue open. I would like to contribute.

This is a very open issue 😄

it's clearly a pretty big feature so if you take that one you probably will want to share some design thoughts, get early feedback or on-going feedback as you progress from the community. (on the Accord Project Slack or in this PR are the most productive options).

something to keep in mind: we would only consider a solution based on open-source libraries (this can be one of the questions when you start looking at existing Web libraries for editing models / graphs etc).

somnathPrasad commented 3 years ago

Ok I am working on this.

somnathPrasad commented 3 years ago

techdocs.zip

Here is a zip file of the completed page, can anyone review it.

Kavisha4 commented 7 months ago

Hey, I am Kavisha Mathur, a 4th year CS major from PESU, India, would like to work on this issue as part of my GSoC'24 contribution. I have set up your codebase on my system. To add this change in the documentation, I see it uses Docusaurus. Web libraries for editing models / graphs etc I would want to explore D3.js (for simple cases) and Fabric.js. Would love to collaborate if someone else wants to take it up, as this issue has been open since quite a while.

rahul2891 commented 2 months ago

Hi, can someone explain the issue like what exactly we have to do?