docsite
docsite copied to clipboard
sourcegraph
The documentation site used by Sourcegraph
As observed on the [Deploy Overview](https://docs.sourcegraph.com/admin/deploy) page, the links on the sidebar are different than the links in their associated header elements: In this case, the header element link resolves...
Rendering mermaidjs blocks like the one found in [Sourcegraph architecture](https://github.com/sourcegraph/sourcegraph/blob/master/doc/dev/architecture.md) would be great to have.
## Use case All Sourcegraph extension tutorials currently have the same set up steps and for now, the same content must be copied and pasted into each. Being able to...
Our developer docs contain some code walkthroughs that would work really well as Sourcegraph notebooks. For example, I tried converting the [Life of a search query docs](https://docs.sourcegraph.com/dev/background-information/architecture/life-of-a-search-query) to a [notebook](https://sourcegraph.com/notebooks/Tm90ZWJvb2s6MTk2Nw==)...
1. Add frontmatter metadata to all pages - at the very least description: canonical_path: twitter_image: 2. Generate a sitemap file for all of the published pages i.e. for handbook: about.sourcegraph.com/sitemap-handbook.xml...
It is rarely used to visit https://docs.sourcegraph.com/@someotherrevision/somepath. But this feature adds a lot of complexity and has caused memory leaks and other problems.
Dociste shouldn't force developers to use `index.md` instead of `README.md` files. `READMD.md` files are advantageous because GitHub, for example, will render the markdown when viewing files at the directory level...
Catching the existence of > 1 h1 level headings would have prevented this [heading hyperlink issue](https://github.com/sourcegraph/sourcegraph/pull/8170)
Nav generation will require new metadata fields such as `navText`, `showInNav`, and `weight`.
On the [NGINX documentation page](https://github.com/sourcegraph/sourcegraph/blob/master/doc/admin/nginx.md), there is a link to a page with the Mermaid.js markup used to render a diagram for non-sighted users. I wanted to link straight to...