René's URL Explorer Experiment


Title: [Suggestion] Restructuring documentation · Issue #697 · pythonindia/junction · GitHub

Open Graph Title: [Suggestion] Restructuring documentation · Issue #697 · pythonindia/junction

X Title: [Suggestion] Restructuring documentation · Issue #697 · pythonindia/junction

Description: Since Junction's documentation is distributed at various places and requires restructuring, I would like to propose the following structure for the readthedocs documentation, suggesting appropriate location for the existing documentation...

Open Graph Description: Since Junction's documentation is distributed at various places and requires restructuring, I would like to propose the following structure for the readthedocs documentation, suggesting appropriate...

X Description: Since Junction's documentation is distributed at various places and requires restructuring, I would like to propose the following structure for the readthedocs documentation, suggesting appropr...

Opengraph URL: https://github.com/pythonindia/junction/issues/697

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Suggestion] Restructuring documentation","articleBody":"Since Junction's documentation is distributed at various places and requires restructuring, I would like to propose the following structure for the readthedocs documentation, suggesting appropriate location for the existing documentation on GitHub wiki. Creating a structure before writing pages will help us write individual pages and recollect them easily.\r\n\r\nI suggest to have 4 level of documentation:\r\n----\r\n1. **Welcome Page**\r\n  - With table of contents reference for whole project for easier and efficient navigation.\r\n  - Link to the \"docs\" labelled issue page to welcome more documentation contribution.\r\n  - License at the end (optional)\r\n\r\n2. **User Level,** to welcome more use of the project among speakers and by other conference organizers with following sections/pages.\r\n  - Installation Guide for local and production environment for different platforms.\r\n  - Quick Start / Getting Started guide, which will cover the steps after installation to use the project. A brief on how one can use the project to setup their CFP acceptance system.\r\n  - Features the project offers\r\n  - How-To(s) to setup and use the project as described [here](https://github.com/pythonindia/junction/issues/627) (migrate content from existing Github wiki over here)\r\n  - FAQ section\r\n  - [Best Practices](https://github.com/pythonindia/junction/wiki/Speaker-best-practices) and [speaker guidelines](https://github.com/pythonindia/junction/wiki/Speaker-Guidelines)\r\n  - Link to release notes page for the sake of history.\r\n\r\n3. **Contribution** page\r\n  -  Contribution guidelines with best practices to create a patch\r\n  - License declaration\r\n  - Pre-requisites such as git/python and django and sharing relevant resources\r\n  - Redirection to easy-to-fix label issues on github\r\n  - Community details, where to contact for help\r\n  - Redirection to Development/developer page\r\n\r\n4. **Development Page**, for developers working on the project\r\n  - Link to contribution guidelines\r\n  - Getting started page link / Installation Page link\r\n  - API resources\r\n  - Structure of the project, detailing on the individual application\r\n----\r\n\r\n#631 \r\n#627 \r\n#589","author":{"url":"https://github.com/miphilomath","@type":"Person","name":"miphilomath"},"datePublished":"2020-06-13T15:41:14Z","url":"https://github.com/pythonindia/junction/issues/697"}

react-profiling0
react-import-mapreact,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-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:a922c829-75f9-0f5f-a4d8-734bb6a51f23
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id9E52:5314B:13D1F0D:191F149:6AFF9CA8
html-safe-nonce646e0609f6753af701f0196625f19da46e8ef6838cd9a829ed97ed98fe3a71d5
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5RTUyOjUzMTRCOjEzRDFGMEQ6MTkxRjE0OTo2QUZGOUNBOCIsInZpc2l0b3JfaWQiOiIyNTI4MDA3NzAxOTk3MjY0MDQwIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac18fc2a4fc8863afc5053d5748120dd45f4493794f0ec3b89dd5eb73a887916bb
hovercard-subject-tagissue:638183119
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/pythonindia/junction/697/issue_layout
twitter:imagehttps://opengraph.githubassets.com/43e5d44d2e3a1d865872684ead6167ec6fe04e17fa2fb79608b51294f7be2789/pythonindia/junction/issues/697
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/43e5d44d2e3a1d865872684ead6167ec6fe04e17fa2fb79608b51294f7be2789/pythonindia/junction/issues/697
og:image:altSince Junction's documentation is distributed at various places and requires restructuring, I would like to propose the following structure for the readthedocs documentation, suggesting appropriate...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamemiphilomath
hostnamegithub.com
expected-hostnamegithub.com
None2c75d045e8c84b51e2ac680086a6dd1eeaf2bc15b82137d22ee5106835d6256c
turbo-cache-controlno-preview
go-importgithub.com/pythonindia/junction git https://github.com/pythonindia/junction.git
octolytics-dimension-user_id1763047
octolytics-dimension-user_loginpythonindia
octolytics-dimension-repository_id27966694
octolytics-dimension-repository_nwopythonindia/junction
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id27966694
octolytics-dimension-repository_network_root_nwopythonindia/junction
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release525b66d22c4f7e6bb8b62934bec198964f7e8b93
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/pythonindia/junction/issues/697#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpythonindia%2Fjunction%2Fissues%2F697
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpythonindia%2Fjunction%2Fissues%2F697
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=pythonindia%2Fjunction
Reloadhttps://github.com/pythonindia/junction/issues/697
Reloadhttps://github.com/pythonindia/junction/issues/697
Reloadhttps://github.com/pythonindia/junction/issues/697
pythonindiahttps://github.com/pythonindia
junctionhttps://github.com/pythonindia/junction
Codehttps://github.com/pythonindia/junction
Issues92 (92)https://github.com/pythonindia/junction/issues
Pull requests28 (28)https://github.com/pythonindia/junction/pulls
Actionshttps://github.com/pythonindia/junction/actions
Projectshttps://github.com/pythonindia/junction/projects
Wikihttps://github.com/pythonindia/junction/wiki
Security and qualityhttps://github.com/pythonindia/junction/security
Insightshttps://github.com/pythonindia/junction/insights
https://github.com/pythonindia/junction
New issuehttps://github.com/login?return_to=https://github.com/pythonindia/junction/issues/697
New issuehttps://github.com/login?return_to=https://github.com/pythonindia/junction/issues/697
[Suggestion] Restructuring documentationhttps://github.com/pythonindia/junction/issues/697#top
https://github.com/miphilomath
area/docshttps://github.com/pythonindia/junction/issues?q=state%3Aopen%20label%3A%22area%2Fdocs%22
type/rfchttps://github.com/pythonindia/junction/issues?q=state%3Aopen%20label%3A%22type%2Frfc%22
https://github.com/miphilomath
miphilomathhttps://github.com/miphilomath
on Jun 13, 2020https://github.com/pythonindia/junction/issues/697#issue-638183119
herehttps://github.com/pythonindia/junction/issues/627
Best Practiceshttps://github.com/pythonindia/junction/wiki/Speaker-best-practices
speaker guidelineshttps://github.com/pythonindia/junction/wiki/Speaker-Guidelines
#631https://github.com/pythonindia/junction/issues/631
#627https://github.com/pythonindia/junction/issues/627
#589https://github.com/pythonindia/junction/issues/589
https://github.com/miphilomath
miphilomathhttps://github.com/miphilomath
on Jun 13, 2020https://github.com/pythonindia/junction/issues/697#issuecomment-643642510
https://user-images.githubusercontent.com/26297035/84573268-02601000-ad8f-11ea-8ff0-0a0061d9de07.png
palnabarunhttps://github.com/palnabarun
miphilomathhttps://github.com/miphilomath
on Jun 13, 2020https://github.com/pythonindia/junction/issues/697#event-3440963012
palnabarunhttps://github.com/palnabarun
area/docshttps://github.com/pythonindia/junction/issues?q=state%3Aopen%20label%3A%22area%2Fdocs%22
on Jun 13, 2020https://github.com/pythonindia/junction/issues/697#event-3440963188
https://github.com/palnabarun
palnabarunhttps://github.com/palnabarun
on Jun 13, 2020https://github.com/pythonindia/junction/issues/697#issuecomment-643652093
@miphilomathhttps://github.com/miphilomath
https://github.com/miphilomath
miphilomathhttps://github.com/miphilomath
on Jun 14, 2020https://github.com/pythonindia/junction/issues/697#issuecomment-643751125
palnabarunhttps://github.com/palnabarun
type/rfchttps://github.com/pythonindia/junction/issues?q=state%3Aopen%20label%3A%22type%2Frfc%22
on Aug 3, 2020https://github.com/pythonindia/junction/issues/697#event-3614409868
Sign up for freehttps://github.com/signup?return_to=https://github.com/pythonindia/junction/issues/697
Sign in to commenthttps://github.com/login?return_to=https://github.com/pythonindia/junction/issues/697
miphilomathhttps://github.com/miphilomath
area/docshttps://github.com/pythonindia/junction/issues?q=state%3Aopen%20label%3A%22area%2Fdocs%22
type/rfchttps://github.com/pythonindia/junction/issues?q=state%3Aopen%20label%3A%22type%2Frfc%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.