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,471 public repositories matching this topic...
I tried to follow the initial steps from here: https://www.learnstorybook.com/intro-to-storybook/react/en/get-started/
running:
npx create-react-app taskbox
cd taskbox
Then when I ran:
npx -p @storybook/cli sb init
I get the error TypeError: Cannot set property 'storybook' of undefined
This is the full message in my terminal:
sb init - the simplest way to add a
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
Definitely not a Python-related wtf, but nice to know anyways
>>> round(1.25, 1)
1.2
>>> round(1.35, 1)
1.4
Explanation idea:
>>> round(1.45) + round(1.55) == 3
True
Hi, 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
From the docs section Add favicon and metadata
Comment in code example states for "The doc
prop contains some metadata about the page being rendered that you can use."
// The doc prop contains some metadata about the page being rendered that you can use.
const Wrapper = ({ children, doc }) => <React.Fragment>
🐛 Bug Report
I get a ReferenceError in Webpack while running yarn build
to deploy the Hermes website.
I think it's due to monaco-editor-webpack-plugin
but I'm not sure.
Have you read the Contributing Guidelines on issues?
Yes
To Reproduce
Note: I setup a branch that has the re
-
Updated
May 18, 2020 - Shell
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
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
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 {
/**
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
- multi-level nav
- clickable index links/page
- auto-generate TOC with sub-leve
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
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
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
May 7, 2020 - CoffeeScript
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
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
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
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
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
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 @mixin
and [`@mix
- Wikipedia
- Wikipedia
Perhaps the most useful command: EOF. No need to use "exit" / "logout" ever again, works in anything using deadline, any shell, and things like cat when using it to create files
cat - > file
.