doc: Document that the fields' order is important for "the serde way"

[martin-g]

#227 (comment)

[Kriskras99]

If we're keeping the README.md and src/lib.rs manually in sync, it might make sense to do something like #![doc = include_str!(../../README.md)]

[martin-g]

It is not manual - we use cargo-rdme.
But your approach might be better!

[Kriskras99]

Check, I think having the badges, License and Contributing in src/lib.rs is totally fine. It also means that a contributor not aware of cargo-rdme doesn't forget to update the readme after fixing/adding something in the documentation

[martin-g]

t also means that a contributor not aware of cargo-rdme doesn't forget to update the readme after fixing/adding something in the documentation

The CI will let him/her know -

avro-rs/.github/workflows/test-lang-rust-ci.yml

Lines 90 to 96 in bd17691

	- name: Run cargo-rdme
	# The result is environment independent so one test pattern is enough.
	if: matrix.rust == 'stable' && matrix.runner.target == 'x86_64-unknown-linux-gnu'
	run: |
	cargo install --root ~/.cargo-${{ matrix.rust }}/cargo-rdme --locked cargo-rdme
	export PATH=$PATH:~/.cargo-${{ matrix.rust }}/cargo-rdme/bin
	cargo rdme --check

[Kriskras99]

Ah perfect. Than it does not really matter