Skip to content

docs: Add Troubleshooting and FAQ section to customization guide #6241

@attardekhushi78-cpu

Description

@attardekhushi78-cpu

Is your feature request related to a problem? Please describe.

Currently, the repository outlines parameters beautifully for setting up the 3D isometric monoliths. However, when users embed these SVGs into their GitHub Profile READMEs, they frequently encounter minor configuration or rendering challenges. Common issues include GitHub’s Camo proxy caching behavior (causing stats to look delayed), responsive scaling issues inside markdown centering tags, or parameter typos.

Describe the solution you'd like

I would like to add a dedicated "Troubleshooting & FAQ" section at the bottom of the customization documentation (docs/customization.md or the relevant markdown file) to address:

  1. GitHub Caching (Camo Proxy): Explain how GitHub caches SVGs and how long it takes to clear, or how to expect update cycles.
  2. Layout & Alignment: Provide quick markdown tips on centering the monolith SVG and making it responsive across device screens.
  3. Parameter Verification: A quick checklist for checking syntax errors if the monolith falls back to default themes.
    This issue is raised as part of the GSSoC '26 program. I would love to work on this! Please assign it to me.

Describe alternatives you've considered

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions