Title: [Suggestion] on the Readme Structure · Issue #696 · pythonindia/junction · GitHub
Open Graph Title: [Suggestion] on the Readme Structure · Issue #696 · pythonindia/junction
X Title: [Suggestion] on the Readme Structure · Issue #696 · pythonindia/junction
Description: I suggest we keep installation instruction separate from Readme, to maintain consistency in the instructions until we have a solid documentation structure. I am sharing a skeleton for the README, I feel we can use with the relevant image...
Open Graph Description: I suggest we keep installation instruction separate from Readme, to maintain consistency in the instructions until we have a solid documentation structure. I am sharing a skeleton for the README, I...
X Description: I suggest we keep installation instruction separate from Readme, to maintain consistency in the instructions until we have a solid documentation structure. I am sharing a skeleton for the README, I...
Opengraph URL: https://github.com/pythonindia/junction/issues/696
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Suggestion] on the Readme Structure","articleBody":"I suggest we keep installation instruction separate from Readme, to maintain consistency in the instructions until we have a solid documentation structure. I am sharing a skeleton for the README, I feel we can use with the relevant images and gifs to welcome new users.\r\n\r\n#589\r\n#545\r\n----------------\r\n### Junction | \\\u003cstatus buttons>\r\n\r\nLatest Version: xx.xx\r\n\r\nOverview with the project demo gif, image so that new users can see how the project looks themselves, or hosting a demo version.\r\n\r\n#### Features\r\n\r\n* Overview about features\r\n\r\n#### Getting Started/Quick-Start\r\n\r\nWith brief and links about following sections on readthedocs.\r\n\r\n* Installation / Setup Guidelines\r\n* How to use the project with hyperlink to tutorial section on readthedocs.\r\n\r\n#### Contribute?\r\n\r\nAdding a brief and links to the relevant page on readthedocs:\r\n\r\n* on contribution guideline\r\n* Prerequisites, such as knowledge of Git/Python/Django etc.\r\n\r\n#### Community\r\n\r\nHow to contact the contributors section with details of zulip chat room or IRC channel details.\r\n\r\n#### License\r\n\r\nBrief on the license the project is using.","author":{"url":"https://github.com/miphilomath","@type":"Person","name":"miphilomath"},"datePublished":"2020-06-13T12:56:15Z","url":"https://github.com/pythonindia/junction/issues/696"}
| 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:0aa26d09-b3e8-5646-baab-4910f5b61cac |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 90BA:CEC0A:19A0220:20FF593:6AFFBA76 |
| html-safe-nonce | a89ce587cbadf398ec106fec3d98f8525354108811a67b2ceb1a312f4231a004 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5MEJBOkNFQzBBOjE5QTAyMjA6MjBGRjU5Mzo2QUZGQkE3NiIsInZpc2l0b3JfaWQiOiI3OTcxNTY3Mjg0NTY5NTYwNiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | b72197cb2382802138c8f0d203c1c6538360222bec771833c594c0483999099a |
| hovercard-subject-tag | issue:638157630 |
| 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/696/issue_layout |
| twitter:image | https://opengraph.githubassets.com/43e5d44d2e3a1d865872684ead6167ec6fe04e17fa2fb79608b51294f7be2789/pythonindia/junction/issues/696 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/43e5d44d2e3a1d865872684ead6167ec6fe04e17fa2fb79608b51294f7be2789/pythonindia/junction/issues/696 |
| og:image:alt | I suggest we keep installation instruction separate from Readme, to maintain consistency in the instructions until we have a solid documentation structure. I am sharing a skeleton for the README, I... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | miphilomath |
| hostname | github.com |
| expected-hostname | github.com |
| None | 7e461843db1c75e40d788c5cfd440d0e4ae1271cf19e06a798d0e7feb2d708f3 |
| 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 | d29a6a99861646939301302fab465f9f123b4773 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width