document formats of input and output files

python-wheel-build / fromager

Build your own wheels

https://fromager.readthedocs.io/en/latest/

Apache License 2.0

7 stars 11 forks source link

Closed dhellmann closed 2 months ago

dhellmann commented 3 months ago

rd4398 commented 2 months ago

What all should the documentation contain? Example of what's included in each file? or just formats like .txt, .json, etc ?
Where should this documentation go? in separate .md file?

dhellmann commented 2 months ago

What all should the documentation contain? Example of what's included in each file? or just formats like .txt, .json, etc ?

A list of the files with descriptions and short examples.

Where should this documentation go? in separate .md file?

A separate file does make sense.