Add more info about favicon.ico. by wieczorek1990 · Pull Request #897 · vapor/docs

wieczorek1990 · 2023-09-04T14:54:39Z

So basically I am going through the docs and found a problem for novice users.

I am linking the article about Xcode working directory paths for use case when running from Xcode. (here)
I am adding the sample for testing a favicon ready website.

Thanks.

Joannis · 2023-09-04T14:57:40Z

docs/getting-started/folder-structure.md

 ```

+If running from Xcode please set the project schema run option working directory.
+See [here](https://docs.vapor.codes/getting-started/xcode/#custom-working-directory) for more information.


You need to use an 'local' link to another markdown file, not an absolute link. The current link doesn't work with localization

Addressed in 02e694e.

wieczorek1990 · 2023-09-04T15:08:19Z

Will do. W dniu pon., 4.09.2023 o 16:58 Joannis Orlandos ***@***.***> napisał(a):

…

***@***.**** requested changes on this pull request. ------------------------------ In docs/getting-started/folder-structure.md <#897 (comment)>: > @@ -35,6 +35,35 @@ let fileMiddleware = FileMiddleware( app.middleware.use(fileMiddleware) ``` +If running from Xcode please set the project schema run option working directory. +See [here](https://docs.vapor.codes/getting-started/xcode/#custom-working-directory) for more information. You need to use an 'local' link to another markdown file, not an absolute link. The current link doesn't work with localization — Reply to this email directly, view it on GitHub <#897 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAMRLK4VLLS6NT4LQYMWXPLXYXT77ANCNFSM6AAAAAA4KRPLJU> . You are receiving this because you authored the thread.Message ID: ***@***.***>

wieczorek1990 · 2023-09-04T17:00:38Z

Need translations.

Joannis · 2023-09-04T19:24:16Z

docs/getting-started/folder-structure.md

+
+To see the `favicon.ico` in action prepare a route in `/Sources/App/routes.swift` like this:
+
+```swift


While I agree that the current docs are pretty unhelpful. I think it might be better to change the existing favicon.ico example to be a different type of file.

The favicon.ico icon is always added at some point in a process of building a full-feature website. It think it should stay.

0xTim

We already have a section on the FileMiddleware so we should just link to that.

I agree however that we should add the note about setting the custom working directory alongside though

wieczorek1990 · 2023-09-05T10:19:31Z

I moved the favicon sample to advanced/middleware.md.

Joannis · 2023-09-18T07:32:04Z

@0xTim

0xTim

I'm going to open this up to the community - personally I don't see what the extra example adds to the current image example.

We should however link the mention on FileMiddleware in the folder structure to the FileMiddleware docs page

alemohamad · 2024-12-13T15:43:26Z

docs/getting-started/folder-structure.md

+If running from Xcode please set the project schema run option working directory.
+See [here](xcode.md#custom-working-directory) for more information.
+
+


I would present this note like this:

Suggested change

If running from Xcode please set the project schema run option working directory.

See [here](xcode.md#custom-working-directory) for more information.

!!! info

If running from Xcode please set the project schema run option working directory.

See [here](xcode.md#custom-working-directory) for more information.

@wieczorek1990 Also check this. 😉

alemohamad · 2024-12-13T15:45:21Z

Personally I don't think that the example code adds much. This can be the same for favicon, styles, javascript, images or any other file saved in the /public folder.

wieczorek1990 · 2024-12-13T15:49:01Z

Every professional modern website has a favicon. W dniu pt., 13 gru 2024 o 16:45 Ale Mohamad ⌘ ***@***.***> napisał(a):

…

Personally I don't think that the example code adds much. This can be the same for favicon, styles, javascript, images or any other file saved in the /public folder. — Reply to this email directly, view it on GitHub <#897 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAMRLK7GUM7RPKKUFD3VGCL2FL6KRAVCNFSM6AAAAABTSHVBUWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNBRG4ZTINZXGI> . You are receiving this because you authored the thread.Message ID: ***@***.***>

alemohamad · 2024-12-13T15:56:20Z

Every professional modern website has a favicon.

Sure! But I don't think there should be an example of this in the docs.

Maybe another way to raise awareness that there should be one is to provide a default favicon in the base project, instead of adding an example that applies to any file stored in the public folder.

wieczorek1990 · 2024-12-13T16:01:59Z

Maybe we need more separated pages where we explain how to add favicon, CSS, HTML, JS files. People search and they should find recipes when they ask. W dniu pt., 13 gru 2024 o 16:56 Ale Mohamad ⌘ ***@***.***> napisał(a):

…

Every professional modern website has a favicon. Sure! But I don't think there should be an example of this in the docs. Maybe another way to raise awareness that there should be one is to provide a default favicon in the base project, instead of adding an example that applies to any file stored in the public folder. — Reply to this email directly, view it on GitHub <#897 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAMRLK36P42FKQNYJHPWXDD2FL7TTAVCNFSM6AAAAABTSHVBUWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNBRG42TINJYGY> . You are receiving this because you authored the thread.Message ID: ***@***.***>

alemohamad · 2024-12-13T16:15:53Z

Maybe we need more separated pages where we explain how to add favicon, CSS, HTML, JS files. People search and they should find recipes when they ask.

I understand what you mean. For this there's the Leaf documentation in the Folder Structure section. Maybe we could name this in that section, but as far as I understand Leaf doesn't have a custom tag to reference resources in the public folder.

What do you think about this approach?

wieczorek1990 · 2024-12-13T16:31:38Z

Yeah, this table of contents feature will do. W dniu pt., 13 gru 2024 o 17:16 Ale Mohamad ⌘ ***@***.***> napisał(a):

…

Maybe we need more separated pages where we explain how to add favicon, CSS, HTML, JS files. People search and they should find recipes when they ask. I understand what you mean. For this there's the Leaf documentation in the Folder Structure <https://docs.vapor.codes/leaf/getting-started/#folder-structure> section. Maybe we could name this in that section, but as far as I understand Leaf doesn't have a custom tag to reference resources in the public folder. What do you think about this approach? — Reply to this email directly, view it on GitHub <#897 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAMRLK7IVCL3NXBVCZNKWYD2FMB47AVCNFSM6AAAAABTSHVBUWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNBRG44TCNBZGY> . You are receiving this because you authored the thread.Message ID: ***@***.***>

Add more info about favicon.ico.

08bfaef

wieczorek1990 requested review from 0xTim and gwynne as code owners September 4, 2023 14:54

Joannis requested changes Sep 4, 2023

View reviewed changes

Fix Markdown document path.

02e694e

wieczorek1990 requested a review from Joannis September 4, 2023 17:00

Joannis reviewed Sep 4, 2023

View reviewed changes

0xTim requested changes Sep 5, 2023

View reviewed changes

Move favicon sample to middleware docs.

5892ce3

wieczorek1990 requested review from 0xTim and Joannis September 5, 2023 10:21

ptoffy added the enhancement label Sep 11, 2023

0xTim requested changes Sep 21, 2023

View reviewed changes

Joannis removed their request for review November 14, 2023 15:11

alemohamad reviewed Dec 13, 2024

View reviewed changes


		To see the `favicon.ico` in action prepare a route in `/Sources/App/routes.swift` like this:

		```swift

		If running from Xcode please set the project schema run option working directory.
		See [here](xcode.md#custom-working-directory) for more information.

Uh oh!

Conversation

wieczorek1990 commented Sep 4, 2023

Uh oh!

Joannis Sep 4, 2023

Choose a reason for hiding this comment

Uh oh!

wieczorek1990 Sep 4, 2023

Choose a reason for hiding this comment

Uh oh!

wieczorek1990 commented Sep 4, 2023 via email

Uh oh!

wieczorek1990 commented Sep 4, 2023

Uh oh!

Joannis Sep 4, 2023

Choose a reason for hiding this comment

Uh oh!

wieczorek1990 Sep 5, 2023

Choose a reason for hiding this comment

Uh oh!

0xTim left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wieczorek1990 commented Sep 5, 2023

Uh oh!

Joannis commented Sep 18, 2023

Uh oh!

0xTim left a comment

Choose a reason for hiding this comment

Uh oh!

alemohamad Dec 13, 2024

Choose a reason for hiding this comment

Uh oh!

alemohamad Dec 13, 2024

Choose a reason for hiding this comment

Uh oh!

alemohamad commented Dec 13, 2024

Uh oh!

wieczorek1990 commented Dec 13, 2024 via email

Uh oh!

alemohamad commented Dec 13, 2024

Uh oh!

wieczorek1990 commented Dec 13, 2024 via email

Uh oh!

alemohamad commented Dec 13, 2024

Uh oh!

wieczorek1990 commented Dec 13, 2024 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

0xTim left a comment •

edited

Loading