Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Write Wiki Page #54

Open
Govind-S-B opened this issue Jun 9, 2023 · 2 comments
Open

Write Wiki Page #54

Govind-S-B opened this issue Jun 9, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@Govind-S-B
Copy link
Owner

Write up wiki with the following pages and their relevant content

Home Page ( intro page )

  • Intro to the project ( a simple single sentence description )
  • Index of contents ( along with navbar )

Features

  • a listing of all the features available in the program and its brief explanation / use cases ( example sorting algo in README )

How to use ( detailed step by step )

Dev Notes ( technical implementation information and documentation for maintainability )

How to contribute

  • fork and PR
  • Issue templates
@Govind-S-B Govind-S-B added the documentation Improvements or additions to documentation label Jun 9, 2023
@Govind-S-B
Copy link
Owner Author

Mention in wiki about additional advanced querying possible by using DB Browser https://sqlitebrowser.org/
such as seeing all the halls or number of records/students in the report.db or editing input.db to a granular level before generation

@Govind-S-B
Copy link
Owner Author

Make the docs in two sections . A user facing docs , and another Dev Docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Govind-S-B