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,257 public repositories matching this topic...
Describe the bug
A clear and concise description of what the bug is.
To Reproduce
Steps to reproduce the behavior:
- Go to 'https://storybookjs.now.sh/official-storybook/?path=/story/addons-jest--with-tests'
in a narrow width browser. - Click on the Tests panel.
- Scroll down to see the tests panel.
- See the total number of tests and total time covering up the "Todo" tex
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
No description provided???
Credit goes to Javier Honduvilla Coto for find this: http://hondu.co/blog/open-and-python
I contacted him by email to clarify a few bits, and thought it'd be a nice addition here.
f = open('/tmp/a', 'w'); open(f.fileno()) # OK
open(open('/tmp/b', 'w').fileno()) # KOHi, I've found the following cheatsheet :
In the README you explain that there must be an edit button in the page and a github button to access the sheet but as you can see it doesn't appear here.
Thx ;)
Bug Report
Describe the bug
I'm testing Docz to integrate it into a Gatsby project. I have followed the steps described on https://www.docz.site/docs/gatsby-theme.
As recommended, I have created a root file doczrc.js for configuration. This is the content:
export default {
themeConfig: {
initialColorMode: "dark",
},
base: "/docs",
src: "./src/docs/🚀 Feature
When I navigate to https://v2.docusaurus.io/docs, I see empty page, not even a sidebar on the left. It would be great if we have a way to define content for this page e.g. docs/index.md
R
-
Updated
Mar 31, 2020 - Shell
I cant view data, properties or something in vue devtools. Only blank page
Open devtools, select vue tab and navigate into components:
- Node version: 10.16.0
- NPM version: 6.9.0
- vue-cli version: (if necessary)
- Operating System: Windows 10 X64
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 'NewInput code
/**
* Canvas
*
* @class Canvas
*/
class Canvas {
/**
* Creates an instance of Canvas.
* @returns {HTMLCanvasElement}
* @memberof Canvas
*/
constructor(width, height) {
const canvas = document.createElement('canvas');
canvas.width = width;
As soon as any page is selected, everything in the navigation gets expanded.
https://sphinx-rtd-theme.readthedocs.io/en/stable doesn't show this, it only expands the current page while everything else gets collapsed. This is the correct behaviour.
I was waiting for the new version exactly for this feature :(
Hello, the example for uploading images is broken http://www.ipandao.com/editor.md/examples/image-upload.html
Perhaps its a firewall thing.
Chrome warning
This site can’t be reached
www.ipandao.com’s server IP address could not be found.
DNS_PROBE_FINISHED_NXDOMAIN
Thanks
I am referencing to https://github.com/styleguidist/react-styleguidist/blob/0ecaaf52e7ce68b41bd202d4fde382a9e8ccef6e/examples/react-native/styleguide.config.js
It seems that adding to the styleguide.config.js configuration does not allow documenting of .web.js components:
{
"webpackConfig": {
"resolve": {
"extensions": [".web.js", ".js"],
}
}
}It
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.
-
Updated
Mar 17, 2020 - CoffeeScript
I am relatively new to GitHub and even newer to Wiki.js & struggled for several hours to properly configure port 80 and 443 proxying to get the wiki my colleague built for our company to automatically work with port 80 & 443 and automatically redirect to port 443 and have it work properly with the wiki node proxy.
I would like to suggest a quick addition of a full proper nginx config (example b
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
How about we collect some advice in docs/translations.md under Keeping translations up to date or similar?
Working on #1118 I naively scrolled through the commit list and looked at merge commits that seemed to add content
-
Updated
Mar 30, 2020
To simplify the installation of cheat & cheatsheets, I created docker-cheat which packages both projects in a single 9 MB docker image. As it may be useful to others as well, I went ahead and linked the project here - specifically from the 'Related Projects' and ['Installing'](https://github.com/che
Is there any particular way to document overloaded constructor?
For example, I would like to document the following constructor:
class Pokemon{
/**
* @param {Object} options - some options
*//**
* @param {String} name - pokemon's name
*/
constructor(arg0){
const options = typeof arg0 === 'object' ? arg0 : {name: arg0};
//do something with
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
it's annoying having to use the mouse to click in the title input to then type! This should be a general feature across all 'new' forms
Currently, the width of the logo is fixed at calc(100% / 6) so that the nav links are flush with the search bar:
Unfortunately, this leads to cut-offs in some translations with longer words in the nav bar:
<img width="127
I haven't compared the lists at length but I think there a lot of merit in merging @markerikson 's webpack advanced techniques list into this repo. It's a little bit of work doing all the copy pasta and finding dupes, but maybe you could label this hacktoberfest on the issue, and someone can find this
Assemble's highly modular nature makes it difficult to discover methods that are added via mixins or inheritance. For example, .use and .define are provided by Base and implicitely added through Templates.
It would be a huge help to have some basic, generated JSDocs that incorporate all of the default packages. JSDoc provides the @mixinand [`@mix
- Wikipedia
- Wikipedia



Some markdown bold syntax is incorrectly displayed.
It should be modified as follows.