-
Notifications
You must be signed in to change notification settings - Fork 8
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
Conversation
raw/index.rst
Outdated
Documentation: http://dev.loklak.org/desktopwok/ | ||
|
||
loklak APIs | ||
----------- |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
okay cool
@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 |
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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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/ |
There was a problem hiding this comment.
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/ |
There was a problem hiding this comment.
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/ |
There was a problem hiding this comment.
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/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use relative link
@mariobehling Still waiting for @yukiisbored's review |
There was a problem hiding this 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.
There was a problem hiding this 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.
@pri22296 I'm sorry, but I don't exactly follow what I should change. Can you please elaborate it more? |
@imujjwal96 use |
@imujjwal96 Please squash the commits. other than that LGTM |
Please move it into |
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