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

Docs: Fix markdown tables #2951

Closed
melissahenderson opened this issue Sep 5, 2024 · 3 comments · Fixed by #3007
Closed

Docs: Fix markdown tables #2951

melissahenderson opened this issue Sep 5, 2024 · 3 comments · Fixed by #3007
Assignees

Comments

@melissahenderson
Copy link
Contributor

Most (not all) of the markdown tables look pretty bad. This is especially the case where the first column contains long variable names.

We need to convert these tables into HTML tables. But first, we need to figure out how we want to style the tables so they're consistent across pages.

@github-project-automation github-project-automation bot moved this to Backlog in Documentation Sep 5, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Rafiki Sep 5, 2024
@melissahenderson melissahenderson moved this from Backlog to In Progress in Documentation Sep 11, 2024
@brad-dow brad-dow moved this from Backlog to In Progress in Rafiki Sep 12, 2024
@brad-dow
Copy link
Contributor

TEXT FORMATTED AS CODE LINE BREAKS
I think we can remedy these tables in a way where we don't have to use raw HTML. After doing a little bit of digging on the project, I can see that the main ILF-docs.css file in the core docs-design-system has a line that defines way lines break specifically when the text is formatted as code in a table:

table code {
word-break: break-all;
}

There are a few ways to handle this:

  • We can modify the docs-design-system CSS to not break up text formatted as code in a table.
  • If this is only a Rafiki problem (which I don't think it is), we can alter the rafiki.css to override that style

If we want to pursue the first option, we'll need to update the docs-design-system CSS and then update all of the other docs pages' dependencies in package.json

If we want to handle it within rafiki.css, it's as simple as making updates as seen in this branch: https://github.com/interledger/rafiki/tree/docs-table-updates

@brad-dow
Copy link
Contributor

TABLES THAT EXTEND PAST THE MAIN CONTENT AREA
In playing around with some markdown tables, I noticed that a table will extend into the right sidebar navigation area. By wrapping the markdown table in a custom div class, we can alter this behavior with a few CSS tweaks.

To see this functionality, run this branch locally: https://github.com/interledger/rafiki/tree/docs-table-updates

@brad-dow
Copy link
Contributor

I've created a PR of my work thus far for @JoblersTune to review and enhance when she gets the chance.

#2990

@github-project-automation github-project-automation bot moved this from In Progress to Done in Rafiki Oct 7, 2024
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Documentation Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants