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.

Is your feature request related to a problem? Please describe
In my component's props TS interface, I can use JSDoc comments to set the description, and can even use the @default tag to describe the default value 💯
However, nothing happens when I use the @deprecated tag.

Describe the solution you'd like
Some ideas:

It would be nice i

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 ;)

🚀 Feature

Feature request from Canny:

I think the back to top button in the v1 should be also implemented in v2. Long docs will ne

Bug Report

I was tasked with resolving a vulnerability coming from trim package. Dependency chain is as follows: trim <- remark-parse <- remark <- react-styleguidist<- our repo.

remark-parse in version 9.0.0 [removes the trim completely](remarkjs/remark@6b42465#diff-0828111e0233dec7891d8f0

I was just contributing to the docs a few minutes ago and after running

yarn check

got this warning

"The prop value with an expression type of SequenceExpression could not be resolved. Please file issue to get this fixed immediately." .

Thought I'd let you know.

Search Terms

Optional type, optional parameters,

Problem

TypeScript 3.0 added support for Optional elements in tuple types, but TypeDoc didn't get support at the same time.

Checklist

Add a new Type model for optional types
Add a test for `type T

Oct	NOV	Dec
	04
2019	2020	2021

Documentation

Here are 6,268 public repositories matching this topic...

jlevy / the-art-of-command-line

storybookjs / storybook

tldr-pages / tldr

freeCodeCamp / devdocs

satwikkansal / wtfpython

chubin / cheat.sh

facebook / docusaurus

🚀 Feature

doczjs / docz

docsifyjs / docsify

Bug Report

charlax / professional-programming

SimulatedGREG / electron-vue

shimohq / chinese-programmer-wrong-pronunciation

nhn / tui.editor

Requarks / wiki

jsdoc / jsdoc

mkdocs / mkdocs

pandao / editor.md

styleguidist / react-styleguidist

sparanoid / chinese-copywriting-guidelines

zealdocs / zeal

github / opensource.guide

Kapeli / Dash-iOS

cheat / cheat

nayafia / lemonade-stand

BookStackApp / BookStack

documentationjs / documentation

reactjs / reactjs.org

"The prop value with an expression type of SequenceExpression could not be resolved. Please file issue to get this fixed immediately." .

squidfunk / mkdocs-material

microsoft / TypeScript-Handbook

TypeStrong / typedoc

Search Terms

Problem

Checklist

Essential cookies

Always active

Analytics cookies