effector / effector/effector

Add anchors to all documentation pages

Open
#1,142 2 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
4.9k
Forks
280
Avg merge
2d 6h
Merged PRs (30d)
7

Description

## Some pages still without IDs

- [ ] https://github.com/effector/effector/blob/master/documentation/src/content/docs/en/typescript/typing-effector.md?plain=1

### Common structure of the head IDs.

Name head as group of camelCase words separated by -. Order words from the general to the particular.

Methods can be written as is. It **is not** required to split `createEffect` into `create-effect`.

Each overload contains unique and full ID: `(#methods-methodName-parameterA-parameterB)`.

Each subsection contains the full ID and suffix: `(#methods-methodName-parameterA-parameterB-arguments)`.

Each method overload variant should contain these sections in the present order:

- formulae
- arguments
- throws
- returns
- types
- examples

Structure of the method documentation, in the header levels:

1. Method name
2. Sections (methods, properties, parameters)
3. Method overload variant
4. Section in the method doc (formulae, arguments, returns)
5. Subsection (useful in Examples)

Example for the attach method

## Methods (#methods)

Method variant

### attach({source, effect}) (#methods-attach-source-effect)

#### Formulae (#methods-attach-source-effect-formulae)

#### Arguments (#methods-attach-source-effect-arguments)

#### Throws (#methods-attach-source-effect-throws)

#### Returns (#methods-attach-source-effect-returns)

#### Types (#methods-attach-source-effect-types)

#### Examples (#methods-attach-source-effect-examples)

##### Some specific example (#methods-attach-source-effect-examples-some-specific-case)

##### Another specific example (#methods-attach-source-effect-examples-another-specific-case)

There can be just one example.

### attach({effect}) (#methods-attach-effect)

#### Formulae (#methods-attach-effect-formulae)

#### Arguments (#methods-attach-effect-arguments)

#### Throws (#methods-attach-effect-throws)

#### Returns (#methods-attach-effect-returns)

#### Types (#methods-attach-effect-types)

#### Examples (#methods-attach-effect-examples)

Also, any non-param case of the parameter or method, should be used as is:

### attach({ effect, mapParams, source }) (#methods-attach-effect-mapParams-source)

#### Formulae (#methods-attach-effect-mapParams-source-formulae)

#### Arguments (#methods-attach-effect-mapParams-source-arguments)

#### Throws (#methods-attach-effect-mapParams-source-throws)

#### Returns (#methods-attach-effect-mapParams-source-returns)

#### Types (#methods-attach-effect-mapParams-source-types)

#### Examples (#methods-attach-effect-mapParams-source-examples)

##### Most typical usage (#methods-attach-effect-mapParams-source-examples-usage)

## Extra parameters (#parameters)

This section do not requires sections in an each parameter description.

### name (#parameters-attach-name)

### domain (#parameters-attach-domain)

## You can check this example as a markdown

Markdown

```md

## Methods (#methods)

Method variant

### attach({source, effect}) (#methods-attach-source-effect)

#### Formulae (#methods-attach-source-effect-formulae)

#### Arguments (#methods-attach-source-effect-arguments)

#### Throws (#methods-attach-source-effect-throws)

#### Returns (#methods-attach-source-effect-returns)

#### Types (#methods-attach-source-effect-types)

#### Examples (#methods-attach-source-effect-examples)

##### Some specific example (#methods-attach-source-effect-examples-some-specific-case)

##### Another specific example (#methods-attach-source-effect-examples-another-specific-case)

There can be just one example.

### attach({effect}) (#methods-attach-effect)

#### Formulae (#methods-attach-effect-formulae)

#### Arguments (#methods-attach-effect-arguments)

#### Throws (#methods-attach-effect-throws)

#### Returns (#methods-attach-effect-returns)

#### Types (#methods-attach-effect-types)

#### Examples (#methods-attach-effect-examples)

Also, any non-param case of the parameter or method, should be used as is:

### attach({ effect, mapParams, source }) (#methods-attach-effect-mapParams-source)

#### Formulae (#methods-attach-effect-mapParams-source-formulae)

#### Arguments (#methods-attach-effect-mapParams-source-arguments)

#### Throws (#methods-attach-effect-mapParams-source-throws)

#### Returns (#methods-attach-effect-mapParams-source-returns)

#### Types (#methods-attach-effect-mapParams-source-types)

#### Examples (#methods-attach-effect-mapParams-source-examples)

##### Most typical usage (#methods-attach-effect-mapParams-source-examples-usage)

## Extra parameters (#parameters)

This section do not requires sections in an each parameter description.

### name (#parameters-attach-name)

### domain (#parameters-attach-domain)

## You can check this example as a markdown

```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.