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

Documentation needs to be made consistent #133

Open
djgroen opened this issue Jul 3, 2019 · 5 comments
Open

Documentation needs to be made consistent #133

djgroen opened this issue Jul 3, 2019 · 5 comments

Comments

@djgroen
Copy link
Owner

@djgroen djgroen commented Jul 3, 2019

We use ReadTheDocs now, but many documents are still in doc in Markdown, not in docs in .rst format. We should amend this, so that the docs are in one place...

@arabnejad
Copy link
Collaborator

@arabnejad arabnejad commented Jul 4, 2019

after converting Markdown to rst format, should we use separate folder for each category, such as /docs/container/ , /docs/plugins/ and so on, or just convert all .md files to .rst and add into docs folder ?

@arabnejad arabnejad self-assigned this Jul 4, 2019
@djgroen
Copy link
Owner Author

@djgroen djgroen commented Aug 1, 2019

Let's make subfolders. I think it is cleaner that way.

@djgroen
Copy link
Owner Author

@djgroen djgroen commented Sep 12, 2019

I don't see this happening today, and it's not urgent.

@djgroen djgroen removed this from the VECMA M15 release milestone Sep 12, 2019
@djgroen djgroen added this to the VECMA M18 release milestone Sep 12, 2019
@djgroen djgroen removed this from the VECMA M18 release milestone Jan 13, 2020
@djgroen djgroen added this to the VECMA M21 Release milestone Jan 13, 2020
@arabnejad
Copy link
Collaborator

@arabnejad arabnejad commented Oct 8, 2020

I think FabSim3 documentation is in a good shape now 😁
@djgroen do you have any suggestion to improve that? if not, I think we can close this issue

@arabnejad
Copy link
Collaborator

@arabnejad arabnejad commented Mar 24, 2021

@djgroen all documentation in doc is already transferred to https://fabsim3.readthedocs.io,
so, I think we can close this issue now

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