question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[TechDocs] Docs side menu not collapsing in small devices

See original GitHub issue

Backstage is using mkdocs material theme, in material if you open the page in small devices then side menu will become collapsable but it is not happening in backstage site.

Expected Behavior

Techdocs content side menu should collapse. you can try open this site and switch to mobile view. https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/

squidfunk github io_mkdocs-material_setup_setting-up-navigation_(iPad) (1) squidfunk github io_mkdocs-material_setup_setting-up-navigation_(iPad)

Current Behavior

Backstage site - techdocs content side menu takes all the space and not readable in mobile device. Screenshot from backstage official demo site. https://demo.backstage.io/docs/default/component/backstage/features/software-catalog/ demo backstage io_docs_default_component_backstage_features_software-catalog_(iPad)

Steps to Reproduce

Open backstage demo site in mobile view. docs side menu doesnt become collapsable as like mkdocs material theme. https://demo.backstage.io/docs/default/component/backstage/features/software-catalog/

To test I installed mkdocs on my local pip3 install mkdocs-techdocs-core==0.2.1

and did mkdocs build and serve the site. It is behaving as expected but when the same site docs were served with backstage then the side menu stopped collapsing for small screens.

Backstage backend deps:

  "dependencies": {
    "@backstage/backend-common": "^0.9.13",
    "@backstage/catalog-client": "^0.5.2",
    "@backstage/catalog-model": "^0.9.7",
    "@backstage/config": "^0.1.11",
    "@backstage/core-plugin-api": "^0.2.1",
    "@backstage/integration": "^0.5.0",
    "@backstage/plugin-auth-backend": "^0.4.9",
    "@backstage/plugin-catalog-backend": "^0.18.0",
    "@backstage/plugin-techdocs-backend": "^0.10.9",
    "@gitbeaker/node": "^29.2.0",
    "@octokit/rest": "^18.5.3",
    "dockerode": "^3.2.1",

  },
  "devDependencies": {
    "@backstage/cli": "^0.6.14",
  },
  • NodeJS Version (v14):
  • Operating System and Version (e.g. Ubuntu 14.04):
  • Browser Information:

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:2
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

3reactions
erikxivcommented, Feb 13, 2022

An attempt to collapse the sidebar on small devices: https://github.com/backstage/backstage/pull/9493

1reaction
erikxivcommented, Apr 14, 2022

I think this can be considered fixed with #9493

Read more comments on GitHub >

github_iconTop Results From Across the Web

TechDocs How-To guides - Backstage.io
In your Backstage instance's app-config.yaml , set techdocs.builder from 'local' to 'external' . By doing this, TechDocs will not try to generate docs....
Read more >
SMA 12.4 Administration Guide - SonicWall
This manual provides the information you need to successfully activate, configure, and administer Secure Mobile Access (SMA) on SonicWall. SMA appliances.
Read more >
Aruba Instant 8.3.0.x User Guide
In addition to this document, the Instant AP product documentation includes the ... items within curly brackets and separated by a vertical bar...
Read more >
Enterprise Home Screen Support & Downloads | Zebra
Additional information and documentation is available at Zebra Techdocs. For more information and developer assistance, please see: TechDocs. See Device ...
Read more >
Port Performance Freight Statistics Program Technical ...
This technical documentation for the PPFSP details the process used to identify the top 25 ports in dry bulk and containerized cargo and ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found