Skip to content

Restructuring and editing docs.#171

Merged
tobymao merged 5 commits into
mainfrom
tracy/mkdoc-edits
Jan 12, 2023
Merged

Restructuring and editing docs.#171
tobymao merged 5 commits into
mainfrom
tracy/mkdoc-edits

Conversation

@technically-tracy

@technically-tracy technically-tracy commented Jan 7, 2023

Copy link
Copy Markdown
Contributor

Editing quick start tutorial and other new docs, adding entries to glossary, adding and updating cross-reference links, restructuring the tables of contents throughout new mkdocs structure, adding css tweaks for a more tobiko-style theme (light and dark modes).

Comment thread README.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@technically-tracy why did you change this ### ? then it doesn't show up on the right hand panel

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I am not sure what you mean. This is how the right-side TOC appears for me:
TOC_right
Are you seeing something different?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ok i guess that's fine

Comment thread docs/api/cli.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this was copy and pasted from the cli help test, so can you fix it there as well?

sqlmesh/cli/main.py

Comment thread docs/api/notebook.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

same with this one, magics.py

Comment thread docs/concepts/overview.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

shouldn't this be two hash tags?

Comment thread mkdocs.yml Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

i think sqlmesh's colors are actually purple

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

No worries, was just trying to be helpful. I'll put it back the way it was.

@tobymao

tobymao commented Jan 12, 2023

Copy link
Copy Markdown
Contributor

great work

@tobymao tobymao merged commit 1c371e0 into main Jan 12, 2023
@tobymao tobymao deleted the tracy/mkdoc-edits branch January 12, 2023 21:04
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.

2 participants