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.

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

Document the project goals, intended user base, status #53

Open
githubsman opened this issue Dec 5, 2022 · 0 comments
Open

Document the project goals, intended user base, status #53

githubsman opened this issue Dec 5, 2022 · 0 comments

Comments

@githubsman
Copy link

What is the final vision for flask-wiki? Who are the intended users and what are their stories? "Wiki" is an open-ended concept, in fact almost a school of related kinds of application (collaborative VS personal, versioning/archiving VS not versioning content, rapid development VS rich content, etc.).

Currently there is no documentation. (Except for local installation, and here is a big THANK YOU for providing a bit of guidance to get me started. It's the first time I've gotten python to render something to localhost, and I am thrilled.)

I suggest the READ ME should have a prospectus in 1-2 paragraphs, and the content of the Demo version should reveal a project plan with some milestones and status markers.

(A case in point: I assume flask-wiki will support creation of a new page (file) by a user. Since I don't see a GUI command, I assume this is simply not yet developed. This need and the plan to fulfill it should be detailed in a page "Making new content". If my assumption of automated page creation is wrong, this again is a good thing to document.)

I realize flask-wiki is an in-house endeavor. I think internal documentation would still help by

  • guiding the in-house team
  • blessing the larger community for whom this has been made a public repo
  • offering a more-fully implemented demonstration.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant