accordproject/concerto-docs

Concerto Data Model Language Documentation Site

concerto-docs's Issues

Broken link to full reference to the Concerto metamodel in Metamodel JSON page

Bug Report 🐛

Expected Behavior

Current Behavior

Possible Solution

Steps to Reproduce

Context (Environment)

Desktop

• OS: [e.g. macOS]
• Browser: [e.g. Chrome, Safari]
• Version: [e.g. 0.22.15]

Detailed Description

Possible Implementation

Need vocabulary codegen info in cli concerto compile docs

Bug Report 🐛

Need vocabulary codegen info in cli concerto compile docs

documentation for vocabulary code generation

Feature Request 🛍️

Context

#644

Documentation for support multiple vocabulary terms for a element.

Feature Request 🛍️

Couldn't find docs for accordproject/concerto#645

Footer link hover effect is too low contrast

Bug Report 🐛

When a user hovers over a link in the footer, it changes into a color that's almost the same as the background, rendering it illegible.

Expected Behavior

On hover, the link should change to a color that has high contrast with the background, so that it's legible. Or the link could have an underline effect appear and stay the same color. Ideally the footer would be visually and functionally consistent with the footer on https://docs.accordproject.org/ .

Current Behavior

When a user hovers over a link in the footer, it changes into a color that's almost the same as the background, rendering it illegible.

Steps to Reproduce

1. Go to https://concerto.accordproject.org/
2. Scroll to the bottom of the page
3. Hover your cursor over one of the footer links

Make line drawings on docs consistent with AP styling

Discussion 🗣

We can replace the line drawings on the docs page with images that are more consistent with the Accord Project branding.

I could image files that match these illustrations found across the AP websites:

Link to static code generation is broken

Bug Report 🐛

Currently, if one is one the quickstart page and clicks on the static code generation in the congratulations section, page not found is shown.

Expected Behavior

Either the page should exist or link should be removed

Current Behavior

404 page renders

Possible Solution

Create a page or remove the link

Context (Environment)

All browsers, desktops and versions

Detailed Description

In my opinion, remove the link

Interested to work on the issue

Yes

Update styling to match Accord Project website

Feature Request 🛍️

Update styling of https://concerto.accordproject.org/ to match https://docs.accordproject.org/ and accordproject.org

Possible Solution

We could update the concerto site, or migrate the old docs to Docusaurus 2, then we'd only need one doc site with one set of styling.

Broken link in Metamodel JSON page

Bug Report 🐛

Link to metamodel.cto is broken in Metamodel JSON page.
Link: https://github.com/accordproject/concerto/blob/main/packages/concerto-metamodel/lib/metamodel.cto
Page: https://concerto.accordproject.org/docs/design/specification/model-metamodel/

Expected Behavior

Link should navigate to metamodel.cto github file.

Current Behavior

Link displays 404 - page not found

Possible Solution

To update the docs to point to the correct link specified below.

Steps to Reproduce

1. Navigate to https://concerto.accordproject.org/docs/design/specification/model-metamodel/
2. Scroll to the bottom
3. Click on the Online link

Context (Environment)

Desktop

• OS: Windows
• Browser: Chrome
• Version: 122.0.6261.94

Detailed Description

Metamodel package has been refactored to it's own repo.
Correct link: https://github.com/accordproject/concerto-metamodel/blob/main/lib/metamodel.cto

Some elements are inconsistent with dark mode design formatting

Bug Report 🐛

Some elements on the concerto docs homepage are rendered in light mode correctly but not in dark mode, sometimes causing difficulty in visibility and leading to inconsistent design.

Expected Behavior

All elements on the page should change color according to the current display mode (light/dark) so as to maintain consistency and readability.

Current Behavior

The elements labeled in the images below are observed to remain unchanged when the user switches to dark mode (or vice versa).

Possible Solution

Fix the behaviour of the mentioned elements such that they change color according to the selected display mode.

Steps to Reproduce

1. Go to the concerto docs homepage.
2. Switch to dark mode.

Context (Environment)

Desktop

• OS: Windows 11
• Browser: Microsoft Edge