Skip to content

Conversation

@blakebyrnes
Copy link
Contributor

@blakebyrnes blakebyrnes commented Mar 4, 2022

This PR adds documentation for Databox and Server, and changes "Website" so it can pull from all nested projects.

Fixes:

  • extractLater could not be destructed
  • CollectedSnippets.getAll should return values only
  • Remove redundant IDatabox interface

To add a new project to the website, you have to:

  1. Add a docs folder to the project with a links.yaml in it to customize the side navigation
  2. Add a plugin entry to gridsome.config.js to read the docs folder of the project
  • this entry must define a unique typeName for the project docs (this is a limitation of gridsome reading from multiple folders)
  • this entry should define an editingDomain that points at the docs location on github
  • point at a new template for this type of doc
  1. Add a website/src/templates/{TemplateName}.vue file with your specified template
  • modify the variables to be your TypeName and point at your links.yaml if copying a previous template

feat(website): unify documentation for projects
@calebjclark calebjclark merged commit 6f25d1b into main Mar 6, 2022
@calebjclark calebjclark deleted the docs branch March 6, 2022 11:12
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

Successfully merging this pull request may close these issues.

2 participants