surrealdb icon indicating copy to clipboard operation
surrealdb copied to clipboard

Removed TOC from readme (#1343)

Open DrBlury opened this issue 1 year ago • 6 comments

Thank you for submitting this pull request! We appreciate you spending the time to work on these changes.

What is the motivation?

Update documentation according to this issue: (#1343)

What does this change do?

Remove the table of contents.

What is your testing strategy?

Check on GitHub if TOC is removed and the rest is still present

Is this related to any issues?

(#1343)

Have you read the Contributing Guidelines?

DrBlury avatar Oct 11 '22 09:10 DrBlury

@DrBlury Would you be so kind to remove it from https://github.com/surrealdb/surrealdb/tree/main/pkg/nix#table-of-contents as well?

rushmorem avatar Oct 11 '22 12:10 rushmorem

I removed another two TOCs which were in other files. I hope this was fine. @rushmorem please check! :)

DrBlury avatar Oct 11 '22 12:10 DrBlury

I removed another two TOCs which were in other files. I hope this was fine. @rushmorem please check! :)

Thanks @DrBlury. The changes themselves are fine.

rushmorem avatar Oct 11 '22 15:10 rushmorem

There doesn't seem to be a table of content in the mobile GitHub app and site, I suggest leaving the ToC for the audience in mobile devices

oricc avatar Oct 11 '22 18:10 oricc

Hi @DrBlury, I'm going to leave the TOC as it is, because, as @oricc stated, there isn't one on GitHub mobile. In addition, I didn't actually know about the TOC button on the GitHub README page, so I'm sure there are others who didn't know about that functionality either 😀 !

tobiemh avatar Oct 18 '22 09:10 tobiemh

No problem! :)

DrBlury avatar Oct 18 '22 13:10 DrBlury