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

[Documentation] Documentation needed for public release #88

Open
6 of 9 tasks
JonathanMace opened this issue Nov 10, 2023 · 2 comments
Open
6 of 9 tasks

[Documentation] Documentation needed for public release #88

JonathanMace opened this issue Nov 10, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@JonathanMace
Copy link
Contributor

JonathanMace commented Nov 10, 2023

  • (Vaastav) deciding on how all documentation, tutorials, API docs, blog posts, website stuff, etc. should be organizing; setting up the processes for all of this; and documenting those processes (and rules about where different kinds of docs should be kept) so that others can easily add documentation to the appropriate places.
  • Code comments: [Documentation] Documentation of applications and plugins (Vaastav) #117
  • Code comments: [Documentation] Documentation of applications and plugins (Jonathan) #118
  • Website: initial blog post(s) e.g. introducing blueprint
  • Website, Repo Docs: tutorials / getting started / 'dive in' type documentation for (a) running an existing application+wiring; (b) changing the existing application's wiring; (c) writing a new application
  • a central page, probably on the website, that indexes all of the known applications
  • a central page, probably in the repo docs, that lists all available plugins
  • repo doc explaining basic expository documentation for (a) writing a plugin; (b) how the wiring spec stuff works; (c) how the IR and code generation works -- this doesn't need to be too good because we can direct people to just talk to us if they want to do these things
  • metadata in github repos and mailing list (e.g. filling out display names, descriptions, links to websites/mailing lists, etc.)
@vaastav
Copy link
Contributor

vaastav commented Jan 10, 2024

Application Index Page: https://blueprint-uservices.github.io/apps/

@vaastav
Copy link
Contributor

vaastav commented Jan 10, 2024

Plugins Index Page: https://blueprint-uservices.github.io/plugins/

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

No branches or pull requests

2 participants