Title: Plan for improving Junction's documentation · Issue #589 · pythonindia/junction · GitHub
Open Graph Title: Plan for improving Junction's documentation · Issue #589 · pythonindia/junction
X Title: Plan for improving Junction's documentation · Issue #589 · pythonindia/junction
Description: I figured it'll be a good idea to have a central location to discuss about the documentation updates I have planned for the project. The general overview is: Get a basic skeleton of sphinx documentation generation into the source tree. I...
Open Graph Description: I figured it'll be a good idea to have a central location to discuss about the documentation updates I have planned for the project. The general overview is: Get a basic skeleton of sphinx document...
X Description: I figured it'll be a good idea to have a central location to discuss about the documentation updates I have planned for the project. The general overview is: Get a basic skeleton of sphinx docu...
Opengraph URL: https://github.com/pythonindia/junction/issues/589
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Plan for improving Junction's documentation","articleBody":"I figured it'll be a good idea to have a central location to discuss about the documentation updates I have planned for the project.\r\nThe general overview is:\r\n\r\n- Get a basic skeleton of sphinx documentation generation into the source tree.\r\n - Include the documents from current documentation (and mark them as old)\r\n- Add \"development\" section with a \"getting started\" page\r\n- Include relevant pages in the generated documentation, with the sources outside the documentation tree (uses the `.. include` ReST directive)\r\n - Contributing Guide\r\n - Code of Conduct\r\n - more?\r\n- Make the API documentation clearer and more extensive\r\n- Add a section for discussing the various functionalities of Junction\r\n - Step-by-step instructions to do common tasks\r\n - Provide overview of the UI\r\n\r\nThe plan is to use Sphinx and ReST for the documentation. I'll add support for Markdown documents to the Sphinx documentation but I won't be writing any new documentation using Markdown.\r\n\r\nFeedback is welcome on this plan.\r\n","author":{"url":"https://github.com/pradyunsg","@type":"Person","name":"pradyunsg"},"datePublished":"2019-04-20T10:08:15Z","url":"https://github.com/pythonindia/junction/issues/589"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:246618a8-0c7b-0b03-3923-71271d9b94f4 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8FCA:145630:2440442:2F55B9A:6AFFF4AD |
| html-safe-nonce | ff80e48e7cfb2e8b48749b48fe5eae1b6f3c8bb6ced7760c628430b7a831b2de |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4RkNBOjE0NTYzMDoyNDQwNDQyOjJGNTVCOUE6NkFGRkY0QUQiLCJ2aXNpdG9yX2lkIjoiMjU3ODg5NjUxNDYyOTc2MDE3MyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 925a88187db4117c494d892b81886eccd87013db1477d97f95197d57694c03bc |
| hovercard-subject-tag | issue:435380588 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/pythonindia/junction/589/issue_layout |
| twitter:image | https://opengraph.githubassets.com/7daa359863997b3bcf45144527c8c09ad651168c8f3813f6188b7f67b491e1ce/pythonindia/junction/issues/589 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/7daa359863997b3bcf45144527c8c09ad651168c8f3813f6188b7f67b491e1ce/pythonindia/junction/issues/589 |
| og:image:alt | I figured it'll be a good idea to have a central location to discuss about the documentation updates I have planned for the project. The general overview is: Get a basic skeleton of sphinx document... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | pradyunsg |
| hostname | github.com |
| expected-hostname | github.com |
| None | 0a0d8686a27478df474dd7415776a7a080cde8838b3cd92ea7601187572e5729 |
| turbo-cache-control | no-preview |
| go-import | github.com/pythonindia/junction git https://github.com/pythonindia/junction.git |
| octolytics-dimension-user_id | 1763047 |
| octolytics-dimension-user_login | pythonindia |
| octolytics-dimension-repository_id | 27966694 |
| octolytics-dimension-repository_nwo | pythonindia/junction |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 27966694 |
| octolytics-dimension-repository_network_root_nwo | pythonindia/junction |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 16a11879678aaf97e2a42c33ee70830aa084fa37 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width