Coder Social home page Coder Social logo

Comments (6)

theskumar avatar theskumar commented on June 24, 2024

@sivaa can we have a proper documentation using mkddocs instead of having it all inside Readme.md to be sane and scaleable. Thoughts?

We can host the docs as proper readthedocs type website at http://pythonindia.github.io/junction if we want.

I can help setting up the initial pages.

from junction.

sivaa avatar sivaa commented on June 24, 2024

@theskumar Sure. Its a good idea.

from junction.

theskumar avatar theskumar commented on June 24, 2024

I've added the initial documentation setup here: 6da6e9f

Available at https://pythonindia.github.io/junction/ . updated by running mkdocs gh-deploy command.

from junction.

kracekumar avatar kracekumar commented on June 24, 2024

We have agreed to use mkdocs. Now we need to add documentation for setting up junction with screen shots.

from junction.

kracekumar avatar kracekumar commented on June 24, 2024

We need to start writing documentation. Documentation should contain setup instruction, how tos, features etc for phase one.

How tos

  • Set up a conference
  • Add reviewers for a conference
  • Assign Section reviewers
  • Private Comments
  • Reviewers only collaboration

Features

One liner/small writeup about existing features.

Setup

  • How to setup third party packages like django-allauth (links to existsing one is also fine)
  • setting up special settings variables.

Thoughts ? @sivaa @theskumar @vanishan @vnbang2003 @ChillarAnand @vigneshsarma @pythonhacker and others.

from junction.

ananyo2012 avatar ananyo2012 commented on June 24, 2024

Moved to #627

from junction.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.