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

editing table of contents #861

Merged
merged 1 commit into from
Jan 23, 2019
Merged

editing table of contents #861

merged 1 commit into from
Jan 23, 2019

Conversation

jckr
Copy link
Contributor

@jckr jckr commented Jan 23, 2019

to correct inconsistencies and add all orphan files

For #756

Background

Change List

@jckr jckr requested a review from ibgreen January 23, 2019 19:57
@@ -46,7 +46,7 @@
},
{
"name": "Using with other Frameworks",
"content": "get-started/using-with-other-frameworks"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this content vs entry is the main reason why the TOC would not render well in gatsby

Copy link
Collaborator

Choose a reason for hiding this comment

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

Unless we can make ocular generate warnings (might be hard for us to detect since the error presumably occurs during the gatsby graphql "magic" processing phase), maybe we need a page with "website debugging tips" to our ocular-gatsby docs.

E.g. if pages are missing, check for this...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right. This is a problem for the ocular package though. Ocular does emits warnings when it cannot find a corresponding node for a TOC entry but not the other way round.

@@ -89,14 +93,14 @@
"name": "Drawing",
"entry": "docs/developer-guide/drawing"
},
{
"name": "Geometry",
"entry": "docs/developer-guide/geometry"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

file doesn't exist. There's a Geometry doc in api reference though

},
{
"name": "WebGL2",
"entry": "docs/user-guide/webgl2"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

there is no use-guide folder in docs

},
{
"name": "GPGPU Programming",
"entry": "docs/user-guide/gpgpu"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

see above. no docs/user-guide

]
},
{
"title": "addons",
Copy link
Contributor Author

@jckr jckr Jan 23, 2019

Choose a reason for hiding this comment

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

For the following 6 entries, the corresponding folders were not taken into account in the TOC

{
"name": "Buffer",
"entry": "docs/api-reference/webgl/buffer"
},
{
"name": "FenceSync",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

file is almost empty btw

@jckr jckr merged commit c493bfc into master Jan 23, 2019
@Pessimistress Pessimistress deleted the edit-toc branch July 26, 2019 19:07
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.

None yet

2 participants