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

Adding start page content for the docs #7

Merged
merged 1 commit into from
May 30, 2017
Merged

Adding start page content for the docs #7

merged 1 commit into from
May 30, 2017

Conversation

imujjwal96
Copy link

Related issue: #2
In this repository, the raw file of various sub-projects will be added to the raw directory, with raw/index.rst being the raw file for the start page content.

Docs of sub-projects will be stored in raw/SUB-PROJECT-NAME

Screenshot

image

raw/index.rst Outdated
Documentation: http://dev.loklak.org/desktopwok/

loklak APIs
-----------
Copy link

@poonai poonai May 12, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add hyper link to respective wrapper library

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where should the hyper link point to? I made the raw file as it was in the issue #2

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

each library having their own repo https://github.com/loklak/loklak_go_api

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But then these APIs ought to have their own documentation. We can at a later stage, when their documentations are integrated, add links to both their github repository and their documentation the way we did with the other repositories.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think our primary focus at the moment should be to integrate everything. Such minor changes can me made afterwards.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay cool

@pri22296
Copy link
Member

@imujjwal96 The screenshot and the index.rst seems to not be in sync. They seem to have different toctrees. Can you attach a screenshot of the site built using the current index.rst

@imujjwal96
Copy link
Author

The screenshot is in sync. The reason why you don't see the last 4 lines in the list is because the links doesn't exist for them and hence they weren't added.

raw/index.rst Outdated

Project Site: http://api.loklak.org

Documentation: http://dev.loklak.org/server
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use relative link instead of absolute for linking to documentation of subproject

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was a bit skeptical about it as these links don't actually exist right now. Maybe we can make these changes later when we have the documentation of these sub-projects in the repository.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@imujjwal96 we can make the required changes in a seperate PR after #1127 gets merged.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

raw/index.rst Outdated

Project Site: http://loklak.net

Documentation: http://dev.loklak.org/search/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use relative link

raw/index.rst Outdated

Project Site: http://apps.loklak.org

Documentation: http://dev.loklak.org/webapps/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use relative link

raw/index.rst Outdated

Code: https://github.com/fossasia/loklak_wok

Documentation: http://dev.loklak.org/androidwok/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use relative link

raw/index.rst Outdated

Code: https://github.com/loklak/loklak_wok_desktop

Documentation: http://dev.loklak.org/desktopwok/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use relative link

@imujjwal96
Copy link
Author

@mariobehling Still waiting for @yukiisbored's review

Copy link
Member

@yukiisbored yukiisbored left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use relative links so it'll work locally, under any domain name, on someone else's computer, on my phone locally, etc.

Copy link
Member

@pri22296 pri22296 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use rst directive :doc: to link to the specific index.rst file within subprojects.

@imujjwal96
Copy link
Author

@pri22296 I'm sorry, but I don't exactly follow what I should change. Can you please elaborate it more?

@pri22296
Copy link
Member

@imujjwal96 use :doc:`DOCUMENTATION <SUB-PROJECT/index>` instead of `DOCUMENTATION <SUB-PROJECT>`_

@pri22296
Copy link
Member

@imujjwal96 Please squash the commits. other than that LGTM

@yukiisbored
Copy link
Member

Please move it into index.rst.d and rename it to 00_readme.rst

@mariobehling mariobehling merged commit ac9f44b into loklak:master May 30, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

5 participants