Skip to content

Conversation

@etimberg
Copy link
Member

@etimberg etimberg commented Dec 30, 2016

Removed old doc files except for the comparison table.

Fixed #3547, #3490, #3118, #2043, #3274, #2362, #2325, #2386, #3299, #3237, #3549 while at it.

@etimberg
Copy link
Member Author

CC @chartjs/maintainers for review

@etimberg
Copy link
Member Author

I should add, the folder structure of the new files is:

  • animations
    • animations.md
  • axes
    • axes.md
    • cartesian
      • category.md
      • linear.md
      • logarithmic.md
      • time.md
    • cartesian-axes.md
    • common-configuration.md
    • labelling.md
    • new-axes.md
    • radial
      • linear.md
    • radial-axes.md
    • styling.md
    • updating-axis-defaults.md
  • bar
    • bar.md
    • config-options.md
    • data-structure.md
    • dataset-properties.md
    • example.md
  • bubble
    • bubble.md
    • config-options.md
    • data-structure.md
    • dataset-properties.md
    • example.md
  • chart-prototype
    • chart-prototype.md
  • colors
    • colors.md
  • developers
    • browser-support.md
    • bugs.md
    • building.md
    • contributing.md
    • extensions.md
    • license.md
    • previous-versions.md
  • elements
    • arc.md
    • bar.md
    • elements.md
    • line.md
    • point.md
  • getting-started
    • getting-started.md
  • global-configuration
  • global-configuration.md
  • horizontal-bar
    • horizontal-bar.md
  • hover
    • hover.md
  • installation
    • installation.md
    • selecting-the-correct-build.md
  • interaction-modes
    • interaction-modes.md
  • layout
    • layout.md
  • legend
    • legend.md
  • line
    • config-options.md
    • data-structure.md
    • dataset-properties.md
    • example.md
    • line.md
  • mixed-chart-types
    • mixed-chart-types.md
  • new-chart-types
  • new-chart-types.md
  • pie
    • config-options.md
    • data-structure.md
    • dataset-properties.md
    • example.md
    • pie.md
  • plugins
    • plugins.md
    • popular-plugins.md
  • polar-area
    • config-options.md
    • data-structure.md
    • dataset-properties.md
    • example.md
    • polar-area.md
  • radar
    • config-options.md
    • data-structure.md
    • dataset-properties.md
    • example.md
    • radar.md
  • responsive-charts
    • responsive-charts.md
  • scatter
    • data-structure.md
    • dataset-properties.md
    • scatter.md
  • stacked-area
    • stacked-area.md
  • stacked-bar
    • stacked-bar.md
  • title
    • title.md
  • tooltips
  • tooltips.md
  • usage
    • common-js.md
    • es6-modules.md
    • require-js.md
    • script-tag.md
    • usage.md

@simonbrunel
Copy link
Member

Nice work, I would hold on before merging to have the Gitbook integration because if a new release is required before, the current doc generator will not work.

About the file structure, what about naming the main file for each directory: README.md:

animations
    README.md (instead of animations.md)
axes
    README.md (instead of axes.md)
...
responsive-charts
    README.md (instead of responsive-charts.md)
...

I saw that practice quite often, that's allow to navigate in the doc directly from GH:

@etimberg
Copy link
Member Author

etimberg commented Jan 1, 2017

I think waiting until we have gitbook integration is a good idea. Any ideas how long it might take to get working? I can change to the README.md names since I'll need to rebase anyway

@tannerlinsley
Copy link
Contributor

tannerlinsley commented Jan 3, 2017 via email

@Menci
Copy link

Menci commented Jan 8, 2017

What doc generator is Chart.js using now?

@etimberg
Copy link
Member Author

etimberg commented Jan 8, 2017

@Menci this doesn't change the generator. @simonbrunel is working on changing it to GitBook

@Menci
Copy link

Menci commented Jan 8, 2017 via email

@simonbrunel
Copy link
Member

@etimberg for consistency, we should move 10-Notes.md under notes/README.md. Can you also post the TOC with the correct section order?

@etimberg etimberg force-pushed the documentation-rewrite branch 2 times, most recently from 4aac82a to 3815036 Compare January 8, 2017 21:59
@etimberg
Copy link
Member Author

etimberg commented Jan 9, 2017

@simonbrunel I made the changes we discussed

@etimberg etimberg added this to the Version 2.6 milestone Jan 15, 2017
@simonbrunel simonbrunel force-pushed the documentation-rewrite branch from 2201e7b to 877a06a Compare January 28, 2017 13:40
@etimberg
Copy link
Member Author

@simonbrunel looking good. Can you fix the conflicts? Then we can start testing this out once v2.5 releases. Great job!

@etimberg etimberg force-pushed the documentation-rewrite branch from 2a1fd0c to a0c48a9 Compare March 18, 2017 11:42
@simonbrunel simonbrunel changed the title Moved docs over to new folder structure Update the docs structure/content to use GitBook Mar 20, 2017
@etimberg etimberg merged commit 3e94b94 into master Mar 21, 2017
@simonbrunel simonbrunel deleted the documentation-rewrite branch March 21, 2017 07:43
@etimberg etimberg mentioned this pull request May 21, 2017
roicos pushed a commit to roicos/Chart.js that referenced this pull request Aug 21, 2017
Update the docs structure/content to use GitBook
exwm pushed a commit to exwm/Chart.js that referenced this pull request Apr 30, 2021
Update the docs structure/content to use GitBook
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants