torvalds-dev / llama_index

LlamaIndex (formerly GPT Index) is a data framework for your LLM applications
https://docs.llamaindex.ai
MIT License
0 stars 0 forks source link

[Documentation]: Azure Cognitive Search page headers shown in sidebar #23

Open torvalds-dev opened 11 months ago

torvalds-dev commented 11 months ago

Documentation Issue Description

Documentation Issue Description

The Azure Cognitive Search page headers appear in the sidebar (see attached). The same seems to be true for a couple of other Vector Store doc pages.

Documentation Link

https://gpt-index.readthedocs.io/en/latest/examples/vector_stores/CognitiveSearchIndexDemo.html

torvalds-dev commented 11 months ago

torvalds.dev is analyzing the ticket

torvalds-dev commented 11 months ago

The issue here is that the headers of the Azure Cognitive Search page are appearing in the sidebar of the documentation. This is likely due to the way the documentation is structured or the way the sidebar is configured to display headers.

Here's a plan to address this issue:

  1. Check the configuration of the documentation. This is usually done in a configuration file like conf.py for Sphinx documentation. Look for settings related to the sidebar or table of contents.

  2. Check the structure of the Azure Cognitive Search documentation page. This is likely written in a markup language like reStructuredText or Markdown. Look for any unusual formatting or directives that might cause headers to appear in the sidebar.

  3. Check other pages that have the same issue. If the same issue appears on multiple pages, it's more likely to be a configuration issue rather than a problem with the individual pages.

  4. Once the cause of the issue is identified, make the necessary changes to the configuration or the individual pages.

The files that are likely relevant to this issue are: