search

Financial-Times / origami

The Origami Component System
52 stars 14 forks source link

docs: add versioning and compatibility for o3 #1733

Closed akomiqaia closed 1 day ago

akomiqaia commented 1 week ago

Describe your changes

We migrated few sections from o2 pages: Compatibility Versioning

The versioning page was linked to major cascade page. In o3 we have not updated the guides and at the moment we are just linking to o2 major-cascade guide.

Issue ticket number and link

698

notlee commented 2 days ago

I think this content needs more scrutiny as we port it over.

  1. Dated guidance: Should we still recommend cuts the mustard? Given our mostly evergreen browser support policy, and ability to conditionally check for feature support in JS, I don't think so.
  2. Content hierarchy: Version and major cascade documentation is displayed prominently under getting started. It may be better suited under technical guides. The ported content also has no clear audience – half is about using Origami, the other half is about contributing to Origami. We should break this up, I'd suggest deleting and coming back to contributor guides.
  3. Verbosity: We explain how semver works and conflict management in great detail. Would it be enough to say we use peer dependencies to ensure one version of a component at a time, and recommend a caret range?
notlee commented 2 days ago

@akomiqaia @frshwtr What do you think? See commit messages for more. I think that includes all the vital information for people using Origami. We may want to restore some content, like on making releases, within contributor guides at a later stage.

akomiqaia commented 1 day ago

I am happy with this. It is much shorter and concise. I would approve it but I open the PR and someone else will need to approve it 😆