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

Improve online documentation #440

Closed

Conversation

JeanPaulShapo
Copy link
Contributor

Main parts:

  • make new section 'Installation'
  • move Windows and Linux tutorials to legacy pages

However, there is need to fix some broken links later.

@JeanPaulShapo
Copy link
Contributor Author

Fixed #386

@JeanPaulShapo
Copy link
Contributor Author

Hope it fixed #395

@sashafrey
Copy link
Contributor

  • Please re-create this pull request against bigartm/stable branch, because it is really useful and we would like to publish it immediately.
  • Remove vim:ft=rst at the end of tutorials/python_api.

@JeanPaulShapo
Copy link
Contributor Author

@sashafrey I wonder why remove vim:ft=rst only in tutorials/python_api :)

@sashafrey
Copy link
Contributor

@JeanPaulShapo I haven't noticed it in other places :)

@JeanPaulShapo
Copy link
Contributor Author

@sashafrey Ok, I fix it in the next commit.

@sashafrey
Copy link
Contributor

@JeanPaulShapo I've added you to commiters group, so feel free to merge your pull request for documentation. Please, create them against bigartm/stable branch because this is the default branch that show up at http://docs.bigartm.org. I will regularly merge bigartm/stable into bigartm/master.

@sashafrey
Copy link
Contributor

For the code I'd still prefer to review and discuss changes, but for documentation I think its OK to just merge. Documentation is now in such a bad state that any change will improve it :) So I fully trust you on this! :)

@JeanPaulShapo
Copy link
Contributor Author

@sashafrey Is it OK not only merge 'documentaton' pull requests but also close 'documentation' issues related to these pull requests?

@sashafrey
Copy link
Contributor

@JeanPaulShapo yes, sure!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants