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.

Sign up for GitHub

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

Jump to bottom

Documentation - Add tables to explain API parameters #638

Closed
paulinea opened this issue Sep 21, 2023 · 2 comments · Fixed by #658
Closed

Documentation - Add tables to explain API parameters #638

paulinea opened this issue Sep 21, 2023 · 2 comments · Fixed by #658
Labels
📖 documentation Improvements or additions to documentation 👌 OK PO

Comments

@paulinea
Copy link
Member

Add a table in markdown file can be done as follow:

Parameters | Descriptions
-- | --
`message: String` | Text to be displayed into the banner
`firstButton: OdsBannerButton` | Principal button to be displayed in the banner
`modifier: Modifier` | `Modifier` to be applied to the banner
`image: OdsBannerImage?` | Image to be displayed in the banner in a circle shape
`secondButton: OdsBannerButton?` | Secondary button to be displayed in the banner
{:.table}

Where {:.table} allows to apply Boosted table style.
@paulinea paulinea added the 📖 documentation Improvements or additions to documentation label Sep 21, 2023
paulinea added a commit that referenced this issue Oct 5, 2023
@paulinea
[#638] Update top app bars documentation
79e5154
paulinea added a commit that referenced this issue Oct 5, 2023
@paulinea
[#638] Update banners documentation
46a2267
paulinea added a commit that referenced this issue Oct 5, 2023
@paulinea
[#638] Add implementation word for concistency
dfeebfb
paulinea added a commit that referenced this issue Oct 5, 2023
@paulinea
[#638] Update bottom bars documentation
9a88994
paulinea added a commit that referenced this issue Oct 5, 2023
@paulinea
[#638] Update buttons documentation
d8d1f51
paulinea added a commit that referenced this issue Oct 6, 2023
@paulinea
[#638] Add space before h4 titles
4efdf12
paulinea added a commit that referenced this issue Oct 6, 2023
@paulinea
[#638] Update cards documentation
a160499
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update checkboxes documentation
9fe545d
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update chips documentation
3f337c8
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update dialogs documentation
edc32d7
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update floating action buttons documentation
98e6e48
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update image tile documentation
8356793
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update image tile documentation
2f21f51
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update menus documentation
cdd23a8
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update bottom navigation documentation
06b97e1
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update progress indicators documentation
7cc3442
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update radio buttons documentation
5d430e5
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Homogenize documentations
8887dab
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update top app bars documentation
3c906c1
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update banners documentation
7a3ad7d
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Add implementation word for concistency
41360c0
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update bottom bars documentation
acfc568
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update buttons documentation
49ae27c
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Add space before h4 titles
d7cfe2f
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update cards documentation
11669e6
paulinea added a commit that referenced this issue Oct 9, 2023
@paulinea
[#638] Update checkboxes documentation
a3fc06b
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Update radio buttons documentation
3a3e049
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Homogenize documentations
1b5ee1f
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Update sliders documentation
17bba32
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Add accessibility information in documentation
b7de95b
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Update switches documentation
72bdcfc
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Review and improve documentation presentation
4382170
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Update changelog
83e5bee
paulinea pushed a commit that referenced this issue Oct 13, 2023
@florentmaitre @paulinea
[#638] Review: Add dots at the end of params description in KDoc
24f5dc6
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Review: Remove line break to fix IDE preview
bbe363a
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Review: Use "soon available" wording
8824b59
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Review: Remove not working tags
331e25b
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Review: Fix scrollBehavior parameter type
4701b26
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Review: Use new API in code example
1d98931
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Review: Use brackets in kdoc
c69032c
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Review: Replace "principal button" by "primary button"
79dea39
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Review: Remove line break
a5cc0f5
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Review: Use OdsSlider and OdsSliderLockups new APIs in examples
8ffd5c4
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Review: Add missing titles in summaries and remove empty sections
2aced85
paulinea added a commit that referenced this issue Oct 13, 2023
@paulinea
[#638] Review: Remove API used in summaries
040a147
@paulinea paulinea assigned B3nz01d and unassigned paulinea Oct 13, 2023
@B3nz01d
Copy link
Collaborator

B3nz01d commented Oct 26, 2023 •
edited
Loading

@paulinea I cannot test this yet right?
I do not see tables in the current exposed doc

@paulinea
Copy link
Member Author

@B3nz01d I sent you the link to test by Teams several days ago: https://deploy-preview-658--ods-android.netlify.app/components/buttons_docs

@B3nz01d B3nz01d removed their assignment Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📖 documentation Improvements or additions to documentation 👌 OK PO
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

638 - Documentation - Add API details and improve documentation Orange-OpenSource/ods-android
2 participants
@paulinea @B3nz01d