> For the complete documentation index, see [llms.txt](https://docs.opshub.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opshub.com/v7.237/contributor-guide-index/content-troubleshooting.md).

# Troubleshoot Formatting Issues

Use the checklist below to diagnose common formatting or rendering issues in your documentation.

### 1. Page Not Visible

* Confirm the page is added to **SUMMARY.md**.
* Check indentation levels in SUMMARY.md.
* Ensure the filename and path are correct (case-sensitive).

### 2. Internal Links Not Working

* Verify the target file exists.
* Check that the file path is correct (e.g., `../folder/page.md`).
* Ensure section links match headings exactly (e.g., `#section-name`).

### 3. Images Not Loading

* Confirm the image is inside the **assets** folder.
* Check that the file name uses **lowercase** and contains **no spaces**.
* Ensure the relative path is correct based on the page location.

### 4. Table Formatting Issues

* Make sure all pipe characters (`|`) are aligned.
* Verify each row has the same number of columns.

### 5. Code Block Problems

* Ensure triple backticks (\`\`\` ) are correctly opened and closed.
* Use language tags only when needed (e.g., `json,` xml).

### 6. Layout or Spacing Issues

* Remove unnecessary blank lines.
* Follow correct heading hierarchy (H1 → H2 → H3).

### 7. Anchor Link Issues

* Ensure headings are unique.
* Avoid using special characters in heading titles.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.opshub.com/v7.237/contributor-guide-index/content-troubleshooting.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
