Adjusting outline-docs package so projects can use them

tekante commented 1 year ago

Description

Modify the build to actually include the documentation files, correct README, and change the template for spinning up new projects to automatically include them in the storybook instance. This will result in the Documentation folder with welcome and guides one sees on https://outline.phase2tech.com/ to be present in the project's Storybook instance as well.

Type of change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update

How Has This Been Tested?

[x] Manually on local instance
[ ] Visual Testing
[ ] Automated Testing
[ ] Accessibility Testing

Checklist

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes
[ ] Any dependent changes have been merged and published in downstream modules

changeset-bot[bot] commented 1 year ago

⚠️ No Changeset found

Latest commit: 0e82fc7aa401ef8a308ebc4f8f808e7af316b70f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

netlify[bot] commented 1 year ago

Deploy Preview for outlinejs ready!

Name	Link
Latest commit	0e82fc7aa401ef8a308ebc4f8f808e7af316b70f
Latest deploy log	https://app.netlify.com/sites/outlinejs/deploys/644dad6ac599550008f22317
Deploy Preview	https://deploy-preview-381--outlinejs.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

himerus commented 1 year ago

For some reason this is failing at the moment as https://yarnpkg.com/package/@phase2/outline-templates is out of sync with https://www.npmjs.com/package/@phase2/outline-templates

Going to merge and move on to see if this somehow clears up. A new release will need to be triggered with these updates anyway.

phase2 / outline