Skip to content

Rethink website publishing so that website describes stable release, not unreleased changes on master #1228

@cspotcode

Description

@cspotcode

Not sure the best way to do this. The website should describe the stable release on npm, not unreleased changes on master.


2x goals:

  • a) We want to be able to fix, improve the website docs and re-publish without an npm release
  • b) But we also want to be able to update docs alongside a new feature implementation, and merge that feature to master without breaking the website.

One solution is to forget about doing a)

The other is to keep either 2x directories or 2x branches of docs:

  • one to describe stable npm release
  • the other to describe new features

Doing this with branches is probably the easiest. Merge master -> docs branch, then run the docusaurus build on the docs branch. Docs updates can be made as PRs directly against the docs branch, not master.

However, that might not play nice with the docusaurus "Edit" button? Do we care?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions