mirror of
https://github.com/meteor/meteor.git
synced 2026-05-02 03:01:46 -04:00
0f6c31cab7
This commit is based on the following design document: https://mdg.hackpad.com/Creating-and-Updating-Docs-0ZyyDcSZDxp, and some other stuff from here: https://mdg.hackpad.com/Meteor-Long-Description-wGZ1vIOwVlF and was code reviewed here: https://github.com/meteor/meteor/pull/3375 It does the following: - Allow the user to specify package documentation in Package.Describe. We will take the README.md file by default, to make the transition easier. Users can specify ‘documentation: null’ to not submit a README.md - From that documentation, extract the section between the first and second header to use as the long form description for the package. - Upload the documentation to the server at publish-time. Allow metadata changes with ‘publish —update’. - Change the default package skeleton to include the README.md file. Also, changes the skeleton to have fewer useless placeholders in Package.describe values. - Fix a minor bug where Git did not show up when running ‘meteor show’ on local packages. A note on ‘documentation: null’ and blank documentation — we don’t let maintainers upload blank README.md files, because we want to encourage people to fill them out. (Instead, we allow a ‘documentation: null’ as an override) This is a UX issue! It is not a technical thing. There is more discussion and code review in: https://github.com/meteor/meteor/pull/3375