Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: markdown doc #365

Merged
merged 3 commits into from
Jan 17, 2024

Conversation

quentinderoubaix
Copy link
Contributor

No description provided.

Copy link

codecov bot commented Jan 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (12c6df6) 92.18% compared to head (5222dec) 92.18%.

❗ Current head 5222dec differs from pull request most recent head 72c1754. Consider uploading reports for the commit 72c1754 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #365   +/-   ##
=======================================
  Coverage   92.18%   92.18%           
=======================================
  Files          95       95           
  Lines        2111     2111           
  Branches      385      385           
=======================================
  Hits         1946     1946           
  Misses         95       95           
  Partials       70       70           
Flag Coverage Δ
e2e-1 35.56% <ø> (-0.97%) ⬇️
e2e-2 60.06% <ø> (-0.51%) ⬇️
e2e-3 63.08% <ø> (+0.28%) ⬆️
e2e-4 56.27% <ø> (+3.08%) ⬆️
e2e-6 82.50% <ø> (ø)
e2e-8 81.52% <ø> (ø)
e2e-9 58.03% <ø> (ø)
unit 90.39% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@quentinderoubaix quentinderoubaix changed the title [WIP] feat: markdown doc feat: markdown doc Jan 16, 2024
Copy link
Member

@andreascorti andreascorti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the MD integration @quentinderoubaix.
As discussed, I think we should have all MDs at root level to make it easy to have a look to the documentation directly from IDE / github (in a second step with a slug convention).


AgnosUI provides two flavours of the widgets for you to choose from:

- **Headless**: The {$selectedFramework$}-headless package contains the headless functionality of the widget library. It can be used with any front-end CSS framework. It uses the core of AgnosUI which is framework agnostic.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we use variables in the MD like {$selectedFramework$}, I think you will need a custom renderer else it will be rendered as html

Copy link
Member

@andreascorti andreascorti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@quentinderoubaix quentinderoubaix merged commit 88f02c7 into AmadeusITGroup:main Jan 17, 2024
11 checks passed
@quentinderoubaix
Copy link
Contributor Author

thx for the review @andreascorti !

@quentinderoubaix quentinderoubaix deleted the docs-structure branch February 5, 2024 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants