filenames become URLs #2

New Issue

2019-11-09T08:33:20Z

mixmix commented

2019-11-09 08:33:20 +00:00

(Migrated from github.com)

hey @mycognosist you may have realised this already, but when you build this project, the files in /src get mapped into html files in /book with the same names, and these essentially become URIs for particular pages.

My recommendation would be to change the names from chapter details (which you may want to change) to semantic descriptions, because this will mean you're less likely to get tripped up / trip other people up who link to the docs <3

hey @mycognosist you may have realised this already, but when you build this project, the files in `/src` get mapped into html files in `/book` with the same names, and these essentially become URIs for particular pages. My recommendation would be to change the names from chapter details (which you may want to change) to semantic descriptions, because this will mean you're less likely to get tripped up / trip other people up who link to the docs <3

👍 1

mixmix commented

2019-11-09 08:42:14 +00:00

(Migrated from github.com)

Just did a quick test and discovered you can happily use folders for nesting / collecting related things e.g. :

- [Introduction](./introduction.md)
- [Hardware](./hardware/index.md)
  - [Requirements](./hardware/requirements.md)
  - [GPIO Pinout](./hardware/gpio_pinout.md)
  - [Physical Interface](./hardware/physical_interface.md)

Just did a quick test and discovered you can happily use folders for nesting / collecting related things e.g. : ``` - [Introduction](./introduction.md) - [Hardware](./hardware/index.md) - [Requirements](./hardware/requirements.md) - [GPIO Pinout](./hardware/gpio_pinout.md) - [Physical Interface](./hardware/physical_interface.md) ```

❤️ 1

mycognosist commented

2019-11-11 08:41:06 +00:00

(Migrated from github.com)

@mixmix ahh yeah the chapter_x_x.md naming was giving me nightmares 😆 Thanks for the reminder! I think the semantic naming approach using folders is the way to go. I've updated the repo accordingly.

@mixmix ahh yeah the `chapter_x_x.md` naming was giving me nightmares :laughing: Thanks for the reminder! I think the semantic naming approach using folders is the way to go. I've updated the repo accordingly.

mixmix commented

2019-11-15 01:25:27 +00:00

(Migrated from github.com)

hooray!

It was fun to be able to contribute to this even if I don't understand the project details yet. Excited to learn more in the future
On Nov 11 2019, at 9:41 pm, glyph notifications@github.com wrote:

@mixmix (https://github.com/mixmix) ahh yeah the chapter_x_x.md naming was giving me nightmares 😆 Thanks for the reminder! I think the semantic naming approach using folders is the way to go. I've updated the repo accordingly.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub (https://github.com/peachcloud/peach-devdocs/issues/2?email_source=notifications&email_token=AAUK3HR5IVSMJN2THELHOBTQTELCFA5CNFSM4JLESJ7KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEDWCDQA#issuecomment-552346048), or unsubscribe (https://github.com/notifications/unsubscribe-auth/AAUK3HSSZUFJNRU3ECT5SG3QTELCFANCNFSM4JLESJ7A).

hooray! It was fun to be able to contribute to this even if I don't understand the project details yet. Excited to learn more in the future On Nov 11 2019, at 9:41 pm, glyph <notifications@github.com> wrote: > @mixmix (https://github.com/mixmix) ahh yeah the chapter_x_x.md naming was giving me nightmares 😆 Thanks for the reminder! I think the semantic naming approach using folders is the way to go. I've updated the repo accordingly. > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub (https://github.com/peachcloud/peach-devdocs/issues/2?email_source=notifications&email_token=AAUK3HR5IVSMJN2THELHOBTQTELCFA5CNFSM4JLESJ7KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEDWCDQA#issuecomment-552346048), or unsubscribe (https://github.com/notifications/unsubscribe-auth/AAUK3HSSZUFJNRU3ECT5SG3QTELCFANCNFSM4JLESJ7A). > >

❤️ 1

Sign in to join this conversation.