accordproject / techdocs Goto Github PK

Tasks

• Possibly adapt this section for concerto, now being a part of accordproject and not hyperledger
  • Could include further information in other locations of the docs

Related Issues:

• N/A

Hacktoberfest:

This issue can provide for multiple pull requests.

The namespace for importing accord project files is specified as 'ord.accordproject' in many places rather than 'org.accordproject'

One example is here:
https://docs.accordproject.org/docs/ergo-stdlib.html

Icons for project on homepage should jump into docs. Currently the navigation via the docs menu header is not obvious

Ergo installation section of the documentation refers to 2 installed ergo commands: ergoc and ergo.
According to the docs, ergo needs to be tested as such:
ergo execute --help
There is no such command installed, however. The installed commands seem to be:
ergoc
ergorun
ergotop

Is your feature request related to a problem? Please describe.
Currently the contributor graphic that shows profile images for contributors in README.md is manually created.

Describe the solution you'd like
It would be awesome if this was created automatically during the Travis build for the master branch.

Describe alternatives you've considered
Currently scripts/get_contributors.sh uses the GitHub API to generate a Markdown file. This file is then rendered as HTML and converted to a PNG.

I'm open to other alternatives pipelines, including third-party services.

Additional context
PR that added the contributor graphic #98

Accord Project documentation needs to be updated to represent new information on our support for scheduled requests and coordination.

This will encompass ergo, cicero, cicero-template-library, models, cicero-ui, and template-studio-v2

Is your feature request related to a problem? Please describe.
We should center logos in repository READMEs, including:

• ergo (Ergo and AP logo)
• cicero (Cicero and AP logo)
• cicero-ui
• markdown-editor
• markdown-transform
• slate-markdown-transform
• template-studio-v2
• cicero-vscode-extension
• cicero-template-library
• models
• etc...

Describe the solution you'd like
Reference babel:

Describe alternatives you've considered
Open to alternatives.

Additional context
N/A

Describe the bug
Wrong URL in Slack button on the main page

To Reproduce
Steps to reproduce the behavior:

1. Go to https://docs.accordproject.org/
2. Click on Slack button
3. You will be redirected to some Google form, and, you need permission here (probably, if you're logged in as an member of owner organisation, you will not see it)

Expected behavior
User should be redirected to the Slack invitation (Probably, here )

Additional context
Perhaps, I wrong here, but, im my opinion, link should be fixed, or, button should be renamed

Linux Foundation logo is missing in the footer of the Technical docs (cf. www.accordproject.org)

Code of Conduct URL is broken in CONTRIBUTING.md

It is redirecting to https://github.com/accordproject/docs/blob/master/Accord%20Project%20Code%20of%20Conduct.pdf

I am sending a PR with this URL https://lfprojects.org/policies/code-of-conduct/

Accord Project documentation needs to be updated to represent our ongoing effort for inclusive design for accessibility. This involves:

Inclusive design is a methodology which enables and draws on the full range of human diversity.

Accessibility is qualities which make an experience open to all and the professional discipline aimed at achieving that.

Checklist:

• Overall accessibility concepts as defined by WCAG 2.1
• Efforts made for inclusive design in Accord Projects's past
  • Incentives to foster participation
• Primary contributors towards accessibility, including initialization and building momentum
• Base requirements as defined by Accord Project to ensure new features are accessible
  • As technical as possible without risk of being soon out of date
  • Referenced as a guide to new contributors
• How to test accessibility
  • Information about screenreaders for manual code testing

Good resources to share:

• The A11Y Project
• WCAG

This will encompass cicero-ui and template-studio-v2, possibly also markdown-editor

Image studio.png is broken inside accordproject-studio.md doc file

Is your feature request related to a problem? Please describe.

NA

Describe the solution you'd like

I'd like to be able to download the current version of the technical specification and associated documentation in a single PDF reference

Tasks

• Dynamic Templates
  • need more information
  • Gain reference material here?
• Markdown Support
  • need more information
  • Cicero there are changes to generateText to accommodate markdown support - working on the details with @jeromesimeon on this
  • Gain reference material here?
• Transform diagram
  • Markdown syntax for templates, details around this
• Update screenshots

Related Issues:

• #86
• Cicero Issue 412

Hacktoberfest:

This issue can provide for multiple pull requests.

Is your feature request related to a problem? Please describe.
'Buyer' and 'Seller' in this documentation must be swapped (seller must pay buyer, not the other way around)

Describe the solution you'd like
As above - both in the text and in the image files

Describe alternatives you've considered
N/A

Additional context
Potentially linked to Cicero Template Library Issue #259

I found some Improper word choice as well as Improper formatting for that I have made changes and corrected that so, now It will be easier for everyone to read.
in pr accordproject/cicero-ui#195

We need to change this in all

Is your feature request related to a problem? Please describe.
We should display a table for our ecosystem on repositories main README, including:

• ergo
• cicero
• cicero-ui
• markdown-editor
• markdown-transform
• slate-markdown-transform
• template-studio-v2
• cicero-vscode-extension
• cicero-template-library
• models
• etc...

Describe the solution you'd like
Reference vue:

Our table should consist of:

• Core:
  • ergo
  • cicero
• Cicero
  • cicero-template-library
  • models
• Markdown
  • markdown-editor
  • markdown-transform
  • slate-markdown-transform
• User Interface
  • cicero-ui
  • template-studio-v2
• Developer Tools
  • cicero-vscode-extension

Describe alternatives you've considered
Open to alternatives. Get feedback from @jeromesimeon @dselman and @mttrbrts

Additional context
Starting point for badges here

Hyperlinks currently do not have a hover effect. Give hyperlinks an underline when the user hovers over them. The color of the underline should be the same as the hyperlink.

Related bug:
Hyperlinks that are bold are black instead of green, making it impossible to tell they are hyperlinks. Make bold hyperlinks the same green as regular hyperlinks

Tasks

• Implement updated Accord Project documentation.

Indicate "Documentation" for all instances of versioning.

• Header between logo and version
• Current Documentation Version (Stable)
• Pre-Release Documentation Versions
• Past Documentation Versions

Describe the bug
In tutorial-nodejs.md, the link to the "Cicero API" leads to a 404 page. I believe the issue might be that the link is missing the document's file extension. A fix is forthcoming.

To Reproduce
Steps to reproduce the behavior:

1. Go to https://github.com/accordproject/techdocs/blob/master/docs/tutorial-nodejs.md
2. Click on "Cicero API" link: https://github.com/accordproject/techdocs/blob/master/docs/cicero-api
3. See 404 page

Expected behavior
Navigation to the Cicero API page.

Screenshots

Desktop (please complete the following information):

• OS: Windows 10
• Browser: Chrome

Additional context
Add any other context about the problem here.

https://docs.accordproject.org/docs/cicero-specification.md not working

Accord Project documentation needs to be updated to represent new information on our support for full contracts. This involves:

• Advanced Template Markup
• Contract Modularity
• Embedded Expressions in Templates

This will encompass ergo, cicero, cicero-template-library, models, cicero-ui, and template-studio-v2

Is your feature request related to a problem? Please describe.
We should create a custom Accord Project badge, available in our published repositories' main README, including:

• ergo
• cicero
• cicero-ui
• markdown-editor
• markdown-transform
• slate-markdown-transform
• etc...

Describe the solution you'd like
Reference styled-components:

Describe alternatives you've considered
Open to alternatives. Get input from @Michael-Grover on design.

Additional context
Starting point for badges here

The Ergo online REPL is currently available at: https://ergorepl.netlify.com

It might be more useful as a kind of "Fiddle" https://jsfiddle.net and linked to the technical documentation here: https://docs.accordproject.org

Since we are using Docusaurus, a possibly nice way to do it could be similar to the ReasonML web site: https://reasonml.github.io and its "try" button!

Is your feature request related to a problem? Please describe.
Currently, we cannot add custom alt text to images. With the new update, this can be fixed.

At the top of the docs page, have four boxes calling out different aspects of the tech docs. The first two are Cicero and Ergo. We currently use text to spell out Cicero and Ergo, however we have logos for those two projects.

Replace this text with the official Cicero and Ergo logos. Make sure there is alt text so that visually impaired people can still identify what these projects are called.

It should look something like this:

Logo SVGs:
logo svgs.zip

The Accord Project text in the nav bar is not the actual Accord Project logo. See the footer for the proper logo:

Here is the SVG file of the proper logo

A-MARK-ACCORDPROJECT-ONELINE-white.svg.zip

@irmerk please add labels to this when you have a chance. I don't have permission to.

Describe the bug
In the nav bar, the Accord Project logo and version number overlaps the search bar on narrow screen widths (mobile)

To Reproduce
Steps to reproduce the behavior:

1. Go to docs.accordproject.org on a mobile device, or reduce your window screen width to below 500px

Expected behavior
We expect the search bar to be accessible at all screen widths.

Suggested fix
At screen widths less than 600px, remove the "ACCORD PROJECT" Text from the Accord Project logo so that just the icon is there.

Set the Alt text to "Return to docs.accordproject.org homepage"

Accord-Project-logo-small.svg.zip

Screenshots

Remove patch version numbers from the semantic versioning of Accord Project documentation.

Instead of v0.13.0, it should be v0.13 since documentation will not be utilizing the patch section of semantic versioning.

Related Issues

• #75

Tasks

• Language
  • New string template syntax `This is text with {% expression %} and more text`
  • Support for enumerated values, with proper typing and pattern matching support
  • Expression sublanguage for modifying state
• Standard Librar
  • New encode and decode functions
  • New format function for DateTime
• Bug fixes
  • now is no longer a magic variable
  • toString now properly format numeric values based on their types
  • constants are now properly imported and scoped, and can be accessed using an explicit namespace
  • Cicero target properly includes type hierarchy

Related Issues:

• #87
• Ergo Issue 646

Hacktoberfest:

This issue can provide for multiple pull requests.

A top-down review of how we organise the information in the documentation and who it is for.

This is becoming more pressing as we work on the documentation for Cicero v0.20 with the new CiceroMark markup, as well as folding in the documentation for Concerto.

Related issues:
#108
#96
#91

Straw man proposal:
https://docs.google.com/spreadsheets/d/1YaGFm6t0Y__tzdG_N6fUCG5EvjdeiffpB3JMdKR-zA0/edit#gid=0

Describe the bug
In DEVELOPERS.md (here), URL of the main repository to be added as upstream has a typo in it. acccordproject should be accordproject

To Reproduce
Steps to reproduce the behavior:

1. Go to DEVELOPERS.md
2. Check 'Add the main repository as an upstream remote to your repository'
3. Notice the typo in URL

Expected behavior
Instead of acccordproject, it should be accordproject

'Add Your Company' link does not work
https://docs.accordproject.org/users.html

To capture first-time visitors, would be benefitted by some infographic or light reading. Maybe most of this project's users are happy with long texts :) as I guess it goes with the domain, I think you could get some Hacktoberfest help from education- and design-skilled people by adding some tasks about generating new explanatory/educational content.

So please see this issue as an encouragement to add some issues :) and I can help generate more ideas on this topic in this thread, or close if you don't need this kind of efforts at this time :). Hope this helps!

Context:
As a person with interests in { formal languages | crypto-based contracts | helping to bring things mainstream :) }, when taking a first look at Accord, it feels like a complex and compact collection of parts that might even be sub-projects, and to get a hang of what it all contains, a lot of clicking and guessing how things fit together is needed.

Accord Project documentation needs to be updated to represent new information on our control of the contract text by embedding logic in the templates. This involves:

• Constructing Tables & Lists
• Handling Text Dependencies
• Handling Optional Text (with Parameters)
• Handling Complex Data

This will also cover syntax updates, which can be viewed more in Cicero Issue #392

This will encompass ergo, cicero, cicero-template-library, models, cicero-ui, and template-studio-v2

Describe the bug
Documentation links to concerto still refer to Hyperledger's repositories

To Reproduce
The highlighted line here has an incorrect link:

Expected behavior
Correct these links to https://github.com/accordproject/concerto

Additional context
There may be further broken links, search through the docs

Replace the template diagram on this page with the new template diagram and update alt text (see below)
https://docs.accordproject.org/

OLD

NEW

Change the alt text to:

"Model, text, and logic are the three components of a Cicero template."

Accord Project documentation needs to be updated to represent our new template studio and its features. This involves:

This will encompass cicero-ui and template-studio-v2

We should review the technical documentation to clarify that Ergo is becoming the main source language for Accord Project templates.

The main changes are likely in https://docs.accordproject.org/docs/accordproject-specification.html
but a more complete review is probably useful.

We should scan through our docs to replace or omit words such as 'simply' or 'just'.

Is your feature request related to a problem? Please describe.
We should display a badge for our slack on repositories' main README, including:

• ergo
• cicero
• cicero-ui
• markdown-editor
• markdown-transform
• slate-markdown-transform
• template-studio-v2
• cicero-vscode-extension
• cicero-template-library
• models
• techdocs (FINISHED @4katie)
• etc...

Describe the solution you'd like
Reference babel:

Describe alternatives you've considered
Open to alternatives.

Additional context
Starting point for badges here

Is your feature request related to a problem? Please describe.
We should display a badge for downloads on repositories' main README which are downloaded, including:

• ergo
• cicero
• cicero-ui
• markdown-editor
• markdown-transform
• slate-markdown-transform
• etc...

Describe the solution you'd like
Reference styled-components:

Describe alternatives you've considered
Open to alternatives.

Additional context

• May need accumulating data, for example cicero consists of cicero-cli, cicero-core, etc.
• Starting point for badges here

Template Specification's expansion arrow stacks when it shouldn't when there is a scrollbar

also, the list is touching the scrollbar

Describe the bug
Before installing node.js dependencies, one must need to navigate into website directory first which is not documented in DEVELOPERS.md

To Reproduce
Steps to reproduce the behavior:

1. Go to DEVELOPERS.md
2. After executing first three commands mentioned, on executing the forth command npm install it fails to find package.json file

Expected behavior
Step to navigate to website directory should be added in the doc

Images on the Accord Project tech docs lack alternative text to describe the information for people with visual impairments.
https://docs.accordproject.org/

Here are some helpful resources:
https://www.w3.org/WAI/tutorials/images/
https://moz.com/learn/seo/alt-text

If you need help deciding what to make the alt text for an image, let me know.

Example of image with no alt text:

Is your feature request related to a problem? Please describe.
We should add a contributors section in our repositories' main README, including:

• ergo
• cicero
• cicero-ui
• markdown-editor
• markdown-transform
• slate-markdown-transform
• template-studio-v2
• cicero-vscode-extension
• cicero-template-library
• models
• etc...

Describe the solution you'd like
This should reference contributors to the specific repository. Reference vue:

Describe alternatives you've considered
Open to alternatives.

Additional context
N/A

Tasks

• Possibly add section to this section for markdown
  • This would capture the tech behind Markdown Transform, Slate Transform, and Markdown Editor
  • Expand on this to describe the significance of Markdown and Concerto in AP
  • This monorepo will contain a CLI which allows people to test transforms at the command line
• Implement screenshots

Related Issues:

• N/A

Hacktoberfest:

This issue can provide for multiple pull requests.

Describe the bug
AP logo in the footer is dulled on rollover:

Should be consistent with www.accordproject.org.

Is your feature request related to a problem? Please describe.
We should add a license badge in our repositories' main README, including:

• ergo
• cicero
• cicero-ui
• markdown-editor
• markdown-transform
• slate-markdown-transform
• template-studio-v2
• cicero-vscode-extension
• cicero-template-library
• models
• etc...

Describe the solution you'd like
Reference vue:

Describe alternatives you've considered
Open to alternatives.

Additional context
Starting point for badges here