Skip to content
This repository has been archived by the owner on Mar 25, 2018. It is now read-only.

notes: handle increasing amounts of notes (that are very specific) #98

Closed
eljefedelrodeodeljefe opened this issue Apr 10, 2016 · 4 comments

Comments

@eljefedelrodeodeljefe
Copy link
Contributor

cc @benjamingr

We are seeing a lot of platform specific notes or refinement of docs (primarily additions) that reason about platform specific behaviours of methods. This might be too much for newcomers to node. In order to handle this we should

  1. have a policy for that
  2. ease this technically (e.g. by having added dimension of collapsable html)
@benjamingr
Copy link
Member

I think easing it technically is good.

I think the notes themselves are definitely a welcome and important addition, I think we should collapse them sans the first sentence by default. Other than placing them with [1]s and so on in the footer (which I think we'd rather avoid) I have no other ideas.

@eljefedelrodeodeljefe
Copy link
Contributor Author

Ah, with notes I rather meant _NOTE: text here_ blocks.

@benjamingr
Copy link
Member

Yeah, me too.

@Trott
Copy link
Member

Trott commented Mar 13, 2018

Closing as this repository is dormant and likely to be archived soon. If this is still an issue, feel free to open it as an issue on the main node repository.

@Trott Trott closed this as completed Mar 13, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants