Skip to content

Readme cleanups for 2.0 #5701

Closed
Closed
@nicolaskruchten

Description

@nicolaskruchten

Let's make a few improvements to the readmes that we can merge at the same time as we do the 2.0 release:

  • the "modules" section is really confusingly named to me... let's rename it to something like "partial bundles" and then highlight that there are two kinds: official/distributed ones (covered in the dist readme) and custom ones (covered in a new readme that will document the custom process)
  • the "building" section should encourage folks to use a partial bundle first, and if not, then basically we should describe how to build the library, although the use-case there is basically (here is what you'll need to do to build your library if your library imports some modules in some other way than via a custom bundle)
  • the dist readme should not contain anything pertaining to MathJax (it used to, because we used to distribute MathJax but we don't any more) and instead MathJax/LaTeX-related stuff should be a short new section in the main readme

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions