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

Migration of the documentation #2433

Closed
29 tasks done
oliviertassinari opened this issue Dec 8, 2015 · 6 comments
Closed
29 tasks done

Migration of the documentation #2433

oliviertassinari opened this issue Dec 8, 2015 · 6 comments
Labels
docs Improvements or additions to the documentation umbrella For grouping multiple issues to provide a holistic view

Comments

@oliviertassinari
Copy link
Member

This is an issue to track the progress of this big task:

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Dec 8, 2015
@alitaheri
Copy link
Member

@oliviertassinari Please check this place before migrating any doc page, I'll keep it updated too. 👍 👍

P.S. I think we should move the examples and readme folders to pages/components, it's will populate the docs/src/app/components too much. don't you agree?

@oliviertassinari
Copy link
Member Author

I think we should move the examples and readme folders to pages/components, it's will populate the docs/src/app/components too much.

Regarding the file/folder organisation. I think that the current solution in a tradeoff.
I think that we should have one folder per component, it makes each component more modular.
I don't like spreading the different files (readme, test, source code, documentation, examples) between different folders.

@alitaheri
Copy link
Member

no no, i meant like this:

instead of:

---docs/src/app/components 
    --- Leftnav
    --- Dialog
    --- ...

We put them in the docs/src/app/components/pages/components:

---docs/src/app/components/pages/components
    --- Leftnav
    --- Dialog
    --- ...

I like it this way, I just mean put these folders in the docs/src/app/components/pages/components folder, it keeps the Folders close to the doc page that uses them.

@oliviertassinari
Copy link
Member Author

I just mean put these folders in the docs/src/app/components/pages/components folder, it keeps the Folders close to the doc page that uses them.

That makes sense 👍.

@alitaheri
Copy link
Member

@oliviertassinari All right, then. I'll try to run a clean up after the PRs are merged.

@newoga
Copy link
Contributor

newoga commented Dec 14, 2015

@alitaheri @oliviertassinari Just letting you know that I'm not ignoring this issue, but didn't went to step on your toes either. If you'd like me to assist with this effort before we tackle some of the other pull requests I previously submitted, let me know. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation umbrella For grouping multiple issues to provide a holistic view
Projects
None yet
Development

No branches or pull requests

3 participants