Skip to content
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.

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

Links to headers in docs #356

Closed
haf opened this issue Mar 2, 2015 · 4 comments
Closed

Links to headers in docs #356

haf opened this issue Mar 2, 2015 · 4 comments

Comments

@haf
Copy link

haf commented Mar 2, 2015

Hello!

Thanks for a great lib! We've just started using it.

Could you please add links to each heading of the docs? E.g. say I wanted to link to the set(at, val) in List(); with github READMEs I can just find the link next to the heading -- could you do something similar?

It would help me share docs with my team! =)

Thanks again for the library!
Henrik

@leebyron
Copy link
Collaborator

leebyron commented Mar 2, 2015

This works today, but I'll keep this task open to make it a bit more obvious.

If you click on a header from the table of contents on the left side, you'll get a link to that location. In your example: http://facebook.github.io/immutable-js/docs/#/List/set

@ghost
Copy link

ghost commented Aug 4, 2015

Thank you for reporting this issue and appreciate your patience. We've notified the core team for an update on this issue. We're looking for a response within the next 30 days or the issue may be closed.

@leebyron
Copy link
Collaborator

leebyron commented Mar 8, 2017

To any contributors looking to help: it would be great if you could click the headers in the docs to get anchor links

liubinyi added a commit to liubinyi/immutable-js that referenced this issue Mar 14, 2017
@liubinyi
Copy link
Contributor

Hi @leebyron I am new to immutable code base. I am giving this a try. hopefully i read the problem correctly. please let me know if this pr needs any update. Thank you!

leebyron pushed a commit that referenced this issue Mar 14, 2017
* added links to header in docs #356

* update naming
kozlitinaelja pushed a commit that referenced this issue Jun 8, 2017
* added links to header in docs #356

* update naming

* Fixes #1239 add descriptive titles

* revert old change

* revert old change
errendir added a commit to errendir/immutable-js that referenced this issue Aug 24, 2017
…ings

* facebook/master: (146 commits)
  Add descriptive titles (immutable-js#1244)
  expect setting Record property to throw (immutable-js#1194)
  Change the has method of Record to be a type guard (immutable-js#1232)
  Add back deleteIn() and removeIn() to Record (immutable-js#1179)
  Fix typo: change 'hiearchy' to 'hierarchy' (immutable-js#1222)
  Fix typo in OrderedMap#toKeyedSeq (immutable-js#1177)
  Fixes missing size property in flow types. (immutable-js#1173)
  Fix size of count() after filtering or flattening (immutable-js#1171)
  Support typescript strictNullChecks (immutable-js#1168)
  added links to header in docs immutable-js#356 (immutable-js#1164)
  Replace "an Collection" with "a Collection" everywhere (immutable-js#1163)
  Fix syntax highlighting and wrong variable names (immutable-js#1159)
  4.0.0-rc.2
  Adds back delete() and clear() to Record (immutable-js#1157)
  Improve filter typescript def to leverage predicate functions (immutable-js#1155)
  Improve type for reduce() (immutable-js#1156)
  Significant improvments to concat type definitions. (immutable-js#1153)
  Update README.md (immutable-js#1150)
  Add note for using with webpack
  Readme improvement pass
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants