Simplify contributing

[fyliu]

Fixes #267

What changes did you make?

• Moved CONTRIBUTING.md sections into files and created links from the original file
  • The original file became the section index page.
• Created contributing/ directory and moved contributing files inside
• Moved tools/ and howto/ (Developer How-to Guides) into contributing/
• Updated links for the above changes.

Why did you make the changes (we will use this info to test)?

• To split the long contributing docs file into topic pages so it'll be easier to add and make changes going forward.
• To organize contributing pages into the Contributing section. Leave main sections for user/customer documentation.

Screenshots of Proposed Changes Of The Website

Before link

Visuals before changes are applied

• Boxes show where the pages were originally.
• The page table of contents used to be on the right.
• There were numbering in the titles, because the document was so long
  • Having numbers as part of the titles (rounded boxes) made it difficult to insert new content because of having to re-number everything after it.

After link

Visuals after changes are applied

• Now, all contributor pages are organized under the "Contributing" section (boxed), leaving the main sections for "customers" (API client developers).
• There's a Contributing index page with links pointing to the other pages.

• Now, page table of contents is shorter and reads better without numbering all the titles

[fyliu]

Maybe the 2 vs. 3 column display needs some more thinking through. I'm going to remove that and recreate screenshots for this PR.

The reasoning is that the Stripe docs use the 3-column format, and it's been the gold standard for software API documentation for a long time. Maybe it's something that users (client developers) prefer.

[shmonks]

Line 6: Change to 'Create initial data scripts' - and maybe change the name of the linked .md file too?

[fyliu]

I don't think we should change the wording here.

Migrations is the term Django uses for this type of scripts. They don't work alone, but have to be run by Django's migration system. https://docs.djangoproject.com/en/5.1/topics/migrations/

It took a while to compare and figure out the best format to keep the initial data and insert them into the database. I should write up a DR to document why.

[shmonks]

Line 165: is the link to Working with Docker page to be inserted later?

[fyliu]

Great catch! localhost is definitely a placeholder link that didn't get cleaned up.

[fyliu]

Fixed

[shmonks]

All good! A few tiny corrections and a couple of comments, that's all.