Summary

Our docs relating to GraphQL sometimes have CodeSandbox samples where viewers can edit their query. However, these pages are represented in the markdown as raw iframes and are quite ugly:

<iframe title="A basic query" src="https://7118

If you use a shortcode in a content file in order to embed a read time estimation for that content file within itself, the estimation always comes back as 0. This is probably because the parser hasn't finished converting the document by the time it gets to the read time estimation so it can't actually get an estimate for it. This is supported by the fact that, when embedding a read time estimation

Currently, there seems to to be very little instruction on how/why certain combinations of _sidebar.md files and folder structures make the sidebar navigation and pagination work.

For example, if my _sidebar.md file contains this:

- **Services**
    - [Getting Started](services/getting-started.md)
    - [Running Service Locally](services/running-services.md)

and my folder

Gollum currently uses custom dialog modals (upload, rename, new). When the switch to Primer CSS has been merged, we should look into deprecated these custom modals for Primer's Box--overlay. At the moment this package is still experimental.

Just a FYI when people start trying to submit bugs about this, mobx-react shipped a funky build which is causing broken-ness (at least when using redoc-cli bundle)

mobxjs/mobx-react#831

Currently breaks with an error like:
Cannot find module '..../.npm/_npx/1868/lib/node_modules/redoc-cli/node_modules/mobx-react/dist/mobxreact.js (added for searchability)

Can

I couldn't load and build the project using the latest qt creator and the wiki guide for building, i think it's out dated, please update and add more details for beginners who want to contribute.

This is not documented anywhere and happens silently, even when using debug

Was reading the the docs, and wanted to make use of the configuration mentioned here, with the nodejs apis.

But, I couldn't find any mention of it in the nodejs api docs. Had to do some digging into the source to see what was truly avail

Refer to:

1. commit-message-guidelines - robertpainsi
2. Follow these git commit message guidelines - theserverside
3. [Writing good commit messages](https://github.com/erlang/otp/wiki/writing-good-commit

Documentation issue

Summary

The get_taxonomy() function documented here and implemented here isn't documented.

From the tests [here](https://github.com/getzola/zola/blob/1972e58823417

The reference implementation for Gherkin has adopted 'Cucumber expressions' which are a type based argument substitution in step definitions, similar to ours but using a different syntax. Ref. https://cucumber.io/docs/cucumber/cucumber-expressions/

We currently allow this transformation in step definitions (ref #863):

@Then I should be a user named :name

In order to increase com

In the documentation, there is a lot of good detail about each individual event that happens (e.g.: https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx-core-events). However, it can be hard to wrap your head around the high-level picture of what happens over the course of a whole build.

In a project we are working on @chrisjsewell gave a really nice description of the birds-eye view

When user presses back button Docute should not try to fetch the markdown file again.

Overview of the issue

When I try to include links in the documentation they do not appears as expected.

Operating System, Node.js, npm, compodoc version(s)

node 12.16.1
npm 6.13.4
compodoc 1.1.11 (installed globally)

Angular configuration, a package.json file in the root folder

Compodoc installed globally or locally ?

globally

https://devexpress.github.io/testcafe/documentation/getting-started/

1. add test:e2e script to package.json which runs testcafe for tests/e2e dir (create dir as well); tests should be run against codedrumbs running at PLAYGROUND_URL (set env var as localhost in webpack.dev config)
2. add page-objects dir in tests/e2e/, put files with selectors there (ID-s for UI controls as well as

The Catalog docs say:

By default, Catalog integrates with Create React App and next.js. Run create-catalog in the same directory as you’ve set up your app.

Upon doing so it installs everything with no errors and says:

Run yarn run catalog-start to get started.

After running yarn run catalog-start I'm getting the following: ```Error: Cannot find module 'babel-plugin-react-requ

I want write multi-line description, like this:

/*
Configurable:
no
---
Value range:
true or false
---
Sending rules:
Does not send if "false", and send in every packet if "true".
---
Description:
Set to "true" when the accelerometer in the device has some problems (poorly soldered or broken).
*/
optional  bool  accelerometer_is_fault = 1;

After documentation generating I

Should exist in the installation manual an example of a systemd documizer-conversion.service
in order to launch at boot the docker appliance with syslog and dns options .

I'm curious as to whether its possible to have multiple documentation sets per install?

Like, could I have docs.example.com/project1/ and docs.example.com/project2/ where each project is loaded from a separate repo?

Sorry if its in the docs, I've read over it a few times but can't seem to find anything.

hi there, in my package.json I have

... 
"build:utils": "jsdoc2md --files ./resources/assets/jsx/app/utils/*.ts* --configure ./jsdoc2md.json > ./resources/assets/jsx/docs/utils.md",

if I run by shell (MacOS, jsdoc2md v5.0.0)

$ jsdoc2md --files ./resources/assets/jsx/app/utils/*.ts* --configure ./jsdoc2md.json > ./resources/assets/jsx/docs/utils.md

all works fine,

It would be good to generate documentation with schemas that has federation support.
Reference https://www.apollographql.com/docs/apollo-server/federation/introduction/

For example, the following federated query fails to generate document

extend type Query {
  me: User
}

type User @key(fields: "id") {
  id: ID!
  username: String!
}

error message:

Must provide schema

For bigger styleguides it's very nice to have a fixed sidebar navigation to:
a) navigate to other parts of the styleguide
b) see where you are in the styleguide

This code inside my main .lsg file already works pretty decently:

@javascript-after transpiler: coffee-script
  $ ->
    $nav = $('<nav id="toc" class="lsg--toc"></nav>')

    $.each $('.lsg--anchor'), (index, anchor) ->
      $anc

Not sure where it's better to place these projects but Adobe started to create a couple of connectors with their products and Magento2:

• https://github.com/adobe/commerce-cif-magento-graphql
• https://github.com/magento/aep-launch
• https://github.com/magento/adobe-stock-integration

They might be useful for someone 😌

I made a start on some IPython magic for rendering eralchemy generated images in a Jupyter notebook: ipython_magic_eralchemy

It really needs factoring into eralchemy and perhaps ipython-sql somehow so that it could make use of a persistent SQL connection. ([ipython-sql magic](https://github.com/catherinedevlin/ipython-sql/b

Currently, the README.md file lists all tables with their full table comment.

I'm putting a lot of info in some of my table descriptions, including SQL code blocks. These render rather badly in the comment column of the central Tables table, which treats markdown just a little different.

Perhaps the Tables table should only use the first paragraph of each table description.

E.g.

You can see it at https://ned14.github.io/status-code/, scroll to the bottom. As you'll see in https://github.com/ned14/status-code/blob/master/include/status_code.hpp, this is happening for member functions defined out of line only. I am on latest develop branch.

https://ruby-doc.org/stdlib-2.7.0/libdoc/rexml/rdoc/REXML/DTD/ElementDecl.html

<p>s*(((([“‘]).*?<a href=”^/’“>”>5)|</a>*)*?)(/)?&gt;/um, true)</p>

https://ruby-doc.org/stdlib-2.7.0/libdoc/net/ftp/rdoc/Ne

Dash allows users to contribute docsets, as outlined in zealdocs/zeal#170. dasht should provide a command to automatically download and extract these as well.

(See also #4.)