Skip to content

Replace current docs by mkdocs#1263

Merged
AlonsoGuevara merged 28 commits intomainfrom
mkdocs
Oct 11, 2024
Merged

Replace current docs by mkdocs#1263
AlonsoGuevara merged 28 commits intomainfrom
mkdocs

Conversation

@andresmor-ms
Copy link
Copy Markdown
Contributor

Replace current docs by MkDocs:

  • It offers search
  • Removes dependencies on node/yarn
  • Plugins for rendering Notebooks
  • Looks better :)

{4A5E9457-D7C5-457F-8EBD-F6819E1A7364}

{3F382827-84B5-4FB6-B09C-AC4D8BFF517C}

@andresmor-ms andresmor-ms requested review from a team as code owners October 9, 2024 23:42
@jgbradley1
Copy link
Copy Markdown
Collaborator

With this mkdocs theme, are you able to add page tabs at the top similar to this page that has the horizontal tabs Home, Getting Starting, Setup, Plugins, etc.?

I also think we should move the doc pages for Prompt Tuning up one level and out of Indexing.

@AlonsoGuevara AlonsoGuevara merged commit fc9895f into main Oct 11, 2024
@AlonsoGuevara AlonsoGuevara deleted the mkdocs branch October 11, 2024 19:39
Connor2573 pushed a commit to Connor2573/graphrag that referenced this pull request Oct 22, 2024
* Replace docs by mkdocs-material

* Fix markdown

* Fix verions in gh-pages workflow

* remove whitespaces

* add semver

* Add build docs check on python-ci

* Fix command in index cli

* Spellcheck

* Spellcheck

* remove docsite paths

* clear outputs from notebook

* remove dependabot npm for docsite

* remove more docsite left overs

* execute notebooks

* Update notebooks

* update poetry lock

* Remove notebook build from ci

* Revert dep update

* Navigation tabs

* Fix stylesheet

* add kwds to dictionary

* Turn on notebook execution

* Update gitignore

* Add MSR Blog posts

* spellcheck

* Accessibility Changes

---------

Co-authored-by: Alonso Guevara <alonsog@microsoft.com>
opensourcemukul pushed a commit to opensourcemukul/graphrag that referenced this pull request Sep 13, 2025
* Replace docs by mkdocs-material

* Fix markdown

* Fix verions in gh-pages workflow

* remove whitespaces

* add semver

* Add build docs check on python-ci

* Fix command in index cli

* Spellcheck

* Spellcheck

* remove docsite paths

* clear outputs from notebook

* remove dependabot npm for docsite

* remove more docsite left overs

* execute notebooks

* Update notebooks

* update poetry lock

* Remove notebook build from ci

* Revert dep update

* Navigation tabs

* Fix stylesheet

* add kwds to dictionary

* Turn on notebook execution

* Update gitignore

* Add MSR Blog posts

* spellcheck

* Accessibility Changes

---------

Co-authored-by: Alonso Guevara <alonsog@microsoft.com>
Brandsma pushed a commit to ThalamusLabs/MMGraphRAG that referenced this pull request Nov 6, 2025
* Replace docs by mkdocs-material

* Fix markdown

* Fix verions in gh-pages workflow

* remove whitespaces

* add semver

* Add build docs check on python-ci

* Fix command in index cli

* Spellcheck

* Spellcheck

* remove docsite paths

* clear outputs from notebook

* remove dependabot npm for docsite

* remove more docsite left overs

* execute notebooks

* Update notebooks

* update poetry lock

* Remove notebook build from ci

* Revert dep update

* Navigation tabs

* Fix stylesheet

* add kwds to dictionary

* Turn on notebook execution

* Update gitignore

* Add MSR Blog posts

* spellcheck

* Accessibility Changes

---------

Co-authored-by: Alonso Guevara <alonsog@microsoft.com>
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.

3 participants