oceanprotocol
Fix tables in the docs
There are multiple tables on our docs that need a bit of cleanup. The problem with most of them is that the widths of all columns are the same. Even if one column needs less space(just for a checkmark). This creates a problem for the columns that need more space, making the table need a horizontal scroll. Example https://docs.oceanprotocol.com/core-concepts/did-ddo#metadata
It seems that something odd maybe happening on the gitbook side which is messing up the tables. @MantisClone reported having trouble with this
There are a couple of other issues with tables that I've noticed:
- Gitbook doesn't handle code embedded in tables well. You can embed code in a table such that it looks correct in the Gitbook editor, but then when it renders or re-syncs, it gets all messed up. I've fixed the tables related to storage objects to use regular code blocks in PR #1082.
- Gitbook injects duplicate rows in a few of the tables each time a new commit is added. The screenshot below shows my latest commit with duplicate rows injected. You can also see that this is not the first time it's happened. There are at least 2 other duplicates above each block of green that are present in the
mainbranch.
I have created a change request directly on gitbook. I submitted for review on Gitbook and left some comments there as well. CC @AnaLoznianu @jamiehewitt15
I have created a change request directly on gitbook. I submitted for review on Gitbook and left some comments there as well. CC @AnaLoznianu @jamiehewitt15
The workflow we follow on the docs is the same as all the other repos, with all change requests handled in pull requests on Github. Can you do it here next time
@jamiehewitt15 Gitbook offers a great visualization tool to edit the tables. You know how difficult it is to edit tables and column lengths on markdown directly. That's why I think for this particular PR, using change requests in gitbook actually makes our life easier.