8000 Add anchors to all documentation pages · Issue #1142 · effector/effector · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add anchors to all documentation pages #1142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
1 task
sergeysova opened this issue Aug 26, 2024 · 2 comments
Open
1 task

Add anchors to all documentation pages #1142

sergeysova opened this issue Aug 26, 2024 · 2 comments
Labels
documentation

Comments

@sergeysova
Copy link
Member
sergeysova commented Aug 26, 2024 •
edited
Loading

Some pages still without IDs

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 
## 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
@sergeysova sergeysova mentioned this issue Aug 26, 2024
Closed
@zerobias
Copy link
Member

https://effector.dev/en/typescript/typing-effector/

@sergeysova
Copy link
Member Author

Basic {#anchors} conflicts with already exists plugins.

sergeysova added a commit that referenced this issue Aug 26, 2024
@sergeysova
docs: add anchors for Typing Effector article
3777541 
#1142
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@sergeysova @zerobias
0