The Wayback Machine - https://web.archive.org/web/20200701132106/https://github.com/topics/documentation
Skip to content
#

Documentation

Documentation is a set of information that describes a product to its users, including what it is, how it operates, and how to use it.

Here are 5,657 public repositories matching this topic...

storybook
lancevalour
lancevalour commented Oct 23, 2019

Describe the bug
In the config.js addParameters function, if I set isFullscreen: true and open the webpage, it is fullscreen on startup. But if I set isFullscreen: false and open the webpage again, it is still full-screen on startup.

To Reproduce

  1. Set isFullscreen: true, open the webpage,
  2. Close the webpage or stop the server
  3. Set isFullscreen: false, open the webpa
tldr
dbrgn
dbrgn commented Feb 28, 2020

The spec says:

If a client has access to environment variables, several standard ones exist to specify the language in which a client should operate. If not, then clients MUST make reasonable assumptions based on the information provided by the environment in which they operate (e.g. consulting navigator.languages in a browser, etc.).

Windows systems do have environment variables, but the

docz
joetidee
joetidee commented Mar 18, 2020

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

MichielDG
MichielDG commented Mar 13, 2020

Version

v1.4.10

Development Environment

Chrome 80.0.3987.132

Current Behavior

Write a description of the current operation. You can add sample code, 'CodePen' or 'jsfiddle' links.

// Write example code
Go to section
* [Hello](#hello)  
* [Hello World](#hello-world)
* [Another section](#new-section)    <-- it's called 'Another section' in this list but refers to 'New
wazybr
wazybr commented May 4, 2020

When generating documentation for a class that extends another, and the base class has it's constructor documented, JSDoc generates duplicated documentation pages for the class that is being extended.

Input code

I was able to reproduce the bug on a minimal example project containing 2 files:

classes/Foo/index.js

/**
 * Represents foo.
 */
export class Foo { 
    /**
   
htleeab
htleeab commented Apr 30, 2020

I'm considering switch to mkdocs from sphinx, but cannot solve the navigation issue.
This is a sample built with sphinx + recommonmark+ readthedocs theme+ readthedocs host
readthedocs theme should support

  1. multi-level nav
  2. clickable index links/page
  3. auto-generate TOC with sub-leve
react-styleguidist
benwiley4000
benwiley4000 commented Feb 7, 2019

When upgrading to the beta I got this error:

./docs_helpers/DocsWrapper.js
Module not found: Can't resolve 'react-styleguidist/lib/rsg-components/StyleGuide/StyleGuideRenderer'

When I change the path to react-styleguidist/lib/client/rgs-components... it compiled.

Since these module locations have been treated as public API (for overrides), their change in location should be d

wiki
TheProgramSrc
TheProgramSrc commented Apr 29, 2020

I was looking how to setup wiki.js on apache for weeks and I want to share this for those that are looking for support. (This little guide is for Ubuntu)

First go to your apache folder (/etc/apache2/) and open the folder "sites-available", then create the file with your subdomain name, for example "wiki.example.com.conf".

Put this code inside the file:
`<VirtualHost *:443>
ServerName wi

jdelman
jdelman commented Jul 17, 2019

When rotating between landscape/portrait, you can lose your open document and position. I have encountered this issue on an iPhone XS Max running iOS 12.3.1.

Steps to recreate:

  • Search for something.
  • View an article.
  • Rotate into landscape mode (on my iPhone XS Max, this shows the search view and the document view side-by-side)
  • Rotate back to portrait

Expected behavior: Show

Biepa
Biepa commented Apr 26, 2020

Describe the feature you'd like
1.) After a click on "Move Page" (I'm using another language, if this isn't the correct translation) a new page opens, where a book etc. can be chosen. I think it would be a good idea, to set the focus on

a) the search field, so you can start searching by typing and then
aa) press enter to confirm, if only one result is displayed
ab) press tab to get to t

estaub
estaub commented Mar 6, 2020

The typeof operator, as used in type queries rather than Javascript, isn't documented, other than as used in documentation of other things, like type guards. Because it is overloaded from the Javascript operator, there can be lots of novice puzzlement.

If your reaction is "that can't possibly be", please look for yourself!

I'd provide a PR, but the wording should be much more precise and co

Wikipedia
Wikipedia
You can’t perform that action at this time.