techdocs icon indicating copy to clipboard operation
techdocs copied to clipboard

Diagram Contract Model

Open jolanglinais opened this issue 4 years ago • 10 comments

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

Screen Shot 2020-03-05 at 8 45 55 AM

jolanglinais avatar Mar 05 '20 13:03 jolanglinais

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

Jigyasa-Kumari avatar Mar 26 '20 16:03 Jigyasa-Kumari

@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.

jeromesimeon avatar Mar 26 '20 16:03 jeromesimeon

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?

Jigyasa-Kumari avatar Mar 28 '20 11:03 Jigyasa-Kumari

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

Nipunagg avatar Mar 30 '20 06:03 Nipunagg

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

somnathPrasad avatar Jun 23 '21 08:06 somnathPrasad

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).

jeromesimeon avatar Jun 23 '21 08:06 jeromesimeon

Ok I am working on this.

somnathPrasad avatar Jun 23 '21 08:06 somnathPrasad

techdocs.zip

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

somnathPrasad avatar Jun 23 '21 16:06 somnathPrasad

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.

Kavisha4 avatar Mar 22 '24 19:03 Kavisha4

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

rahul2891 avatar Sep 14 '24 06:09 rahul2891