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

Re-arrange the documentation structure for readability #4

Open
miphe opened this issue Jul 25, 2016 · 2 comments
Open

Re-arrange the documentation structure for readability #4

miphe opened this issue Jul 25, 2016 · 2 comments
Assignees
Milestone

Comments

@miphe
Copy link
Member

miphe commented Jul 25, 2016

At the moment the structure of documentation is as follows:

root
  |__README.md
  |__example/
    |__README.md
    |__chart/
      |__README.md
      |__dimension/
        |__README.md
      etc.....
    |__tooltip/
      |__README.md
      |__dimension/
        |__README.md
      etc.....

All documents are named README.md and are organized under a directory of concern. A more accessible structure would be:

root
  |__README.md
  |__example/
    |__README.md
    |__chart/
      |__README.md
      |__dimension.md
      |__font.md
      |__position.md
      etc.....
    |__tooltip/
      |__README.md
      |__dimension.md
      |__font.md
      |__position.md
      etc.....

The function of files named README.md is to give an overview of the content of the current directory, as this file will be shown by GitHub in it's preview when navigating throughout the repository.

@miphe miphe added this to the 2.1.0 milestone Jul 25, 2016
@anteAdamovic
Copy link
Contributor

I was intending to write an example for each of the directories to show the use of those functions and how to alter the properties of the chart itself. But I can rearrange them if necessary in the next release.

@anteAdamovic anteAdamovic self-assigned this Jul 26, 2016
@miphe
Copy link
Member Author

miphe commented Jul 26, 2016

I see, when that is done this issue can be considered obsolete and closed.

@anteAdamovic anteAdamovic modified the milestones: 2.1.1, 2.1.0 Aug 1, 2016
@anteAdamovic anteAdamovic modified the milestones: 3.0.2, 2.1.1 Sep 23, 2016
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

2 participants