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 4,899 public repositories matching this topic...

storybook
levelingup
levelingup commented Dec 24, 2019

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
endiliey
endiliey commented Nov 12, 2019

💥 Proposal

Consider making https://v2.docusaurus.io/docs/docusaurus.config.js#tagline and https://v2.docusaurus.io/docs/docusaurus.config.js#favicon as part of themeConfig and not as required fields

In v1, it has to be required field because a lot of the React components need it and all the UI is locked-in. This is no longer the case in v2, i think its very coupled to theme-classic and th

anikethsaha
anikethsaha commented Dec 23, 2019

After adding eslint, if your run npx eslint . it will show huge number of errors and warning.

This issue is to fix those errors and warning and remove/add eslint rules if required after discussing here.

Also, eslint script and .eslintignore should be configured as follows.

package.json

"lint": "eslint . --fix",

.eslintrc

{
  "extends": "xo-space/br
fridgerator
fridgerator commented Oct 23, 2018

Unit tests for main should be included as well as renderer unit tests.

Many electron apps keep a lot of logic in the main process, and unit tests for this code is also important.

germanz
germanz commented Dec 10, 2019

When the parent class overrides the inherited method, that method is not documented in the child class. The example below shows 3 classes Shape, ConvexPolygon, Rectangle inheriting from each other respectfully.

/**
 * @class
 */
class Shape {
  /**
   * Returns the area of the shape
   * @publish
   */
  getArea() {}
}

/**
 * @class
 * @extends Shape
 */
class ConvexPolyg
react-styleguidist
sapegin
sapegin commented Dec 15, 2019

You can define state in each example using a custom initialState/setState API:

initialState = { count: 42 }
;<Button onClick={() => setState({ count: state.count + 1 })}>
  {state.count}
</Button>

This was implemented long before hooks but does the same thing as hooks:

const [count, setCount] = React.useState(42)
;<Button onClick={() => setCount(count + 1)}>{count
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

wiki
DelfrCorp
DelfrCorp commented Oct 9, 2019

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

sdondley
sdondley commented Apr 13, 2019

Sorry to pollute the issue queue with this but I wasn't sure where else to put it.

I wrote a couple of simple bash functions that make it easy to pull up and edit a cheat document in a new pane and close it from the command line when using tmux. Maybe it could be included in the documentation somewhere.

tmux_cheat_page() {
if [[ "$TERM" =~ 'screen' ]] && [[ -n "$CHEAT_EDITOR" ]]; then
trusktr
trusktr commented Aug 9, 2019

Gleening from some examples in the issues, I'm running

documentation serve ./src/index.js --parse-extension ts

and src/index.js has an export * from './components' where the ./components folder has index.ts, and I get

Error: Cannot find module './components' from '/Users/trusktr/src/infamous+infamous/src'

Then I tried

documentation serve ./src/i
openmoto
openmoto commented Jul 4, 2019

Describe the feature you'd like
Voting feature: Ideally allow registered user to click on the "Worked for me" button to increase the count. Great if the option can be 'renamed' to upvote/downvote or any other to suite the use case.

Optionally allow feedback and give reader the chance to explain what went wrong privately [not another wordpress ;) ]

**Describe the benefits this feature w

mootari
mootari commented Dec 28, 2017

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
You can’t perform that action at this time.