update comments and README

README.md

@@ -38,7 +38,10 @@ Astro Cactus is a simple opinionated starter built with the Astro framework. Use
 - Pagination
 - [Automatic RSS feed](https://docs.astro.build/en/guides/rss)
 - [Webmentions](https://webmention.io/)
-- Auto-generated [sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/)
+- Auto-generated:
+  - [sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/)
+  - [robots.txt](https://github.com/alextim/astro-lib/blob/main/packages/astro-robots-txt/README.md)
+  - [web app manifest](https://github.com/alextim/astro-lib/blob/main/packages/astro-webmanifest/README.md)
 - [Pagefind](https://pagefind.app/) static search library integration
 - [Astro Icon](https://github.com/natemoo-re/astro-icon) svg icon component
 - [Expressive Code](https://expressive-code.com/) source code and syntax highlighter
@@ -84,11 +87,12 @@ Replace pnpm with your choice of npm / yarn
 
 - Edit the config file `src/site.config.ts` for basic site meta data
   - Read [this post](http://astro-cactus.chriswilliams.dev/posts/webmentions/) for adding webmentions to your site, otherwise set `siteConfig.webmentions.link` to an empty value.
-- Update file `astro.config.ts` site property with your own domain.
+- Update file `astro.config.ts`
+  - **Important**: the site property with your own domain.
+  - [astro-webmanifest options](https://github.com/alextim/astro-lib/blob/main/packages/astro-webmanifest/README.md)
 - Replace & update files within the `/public` folder:
-  - favicon.ico & other social icons
-  - robots.txt - update the Sitemap url to your own domain
-  - manifest.webmanifest
+  - icon.svg - used as the source to create favicons & manifest icons
+  - social-card.png - used as the default og:image
 - Modify file `src/styles/global.css` with your own light and dark styles.
   - You can also modify the theme(s) for markdown code blocks generated by [Expressive Code](https://expressive-code.com). Astro Cactus has both a dark (dracula) and light (github-light) theme, which can be found in `src/site.config.ts`. You can find more theme(s) and options [here](https://expressive-code.com/guides/themes/#available-themes).
 - Edit social links in `src/components/SocialList.astro` to add/replace your media profile. Icons can be found @ [icones.js.org](https://icones.js.org/), per [Astro Icon's instructions](https://www.astroicon.dev/guides/customization/#find-an-icon-set).
@@ -147,7 +151,7 @@ You may want to track the number of visitors you receive to your blog/website in
 
 This theme/template doesn't include a specific solution due to there being a number of use cases and/or options which some people may or may not use.
 
-You may be asked to included a snippet inside the **HEAD** tag of your website when setting it up, which can be found in `src/layouts/Base.astro`. Alternatively, you could add the snippet in `src/components/BaseHead.astro`.
+You may be asked to included a snippet inside the **HEAD** tag of your website when setting it up, which can be found in `src/layouts/Base.astro`. Alternatively, you can add the snippet in `src/components/BaseHead.astro`.
 
 ## Deploy
 

astro.config.ts

@@ -46,10 +46,10 @@ export default defineConfig({
 			// short_name: "Astro_Cactus",
 			description: siteConfig.description,
 			lang: siteConfig.lang,
-			icon: "public/icon.svg", // source for favicon & icons
+			icon: "public/icon.svg", // the source for generating favicon & icons
 			icons: [
 				{
-					src: "icons/apple-touch-icon.png",
+					src: "icons/apple-touch-icon.png", // used in src/components/BaseHead.astro L:26
 					sizes: "180x180",
 					type: "image/png",
 				},

src/site.config.ts

@@ -13,15 +13,15 @@ export const siteConfig: SiteConfig = {
 			year: "numeric",
 		},
 	},
-	// Meta property used as the default description meta property
+	// Used as the default description meta property and webmanifest description
 	description: "An opinionated starter theme for Astro",
-	// HTML lang property, found in src/layouts/Base.astro L:18
+	// HTML lang property, found in src/layouts/Base.astro L:18 & astro.config.ts L:48
 	lang: "en-GB",
 	// Meta property, found in src/components/BaseHead.astro L:42
 	ogLocale: "en_GB",
 	// Option to sort posts by updatedDate if set to true (if property exists). Default (false) will sort by publishDate
 	sortPostsByUpdatedDate: false,
-	// Meta property used to construct the meta title property, found in src/components/BaseHead.astro L:11
+	// Used to construct the meta title property found in src/components/BaseHead.astro L:11, and webmanifest name found in astro.config.ts L:42
 	title: "Astro Theme Cactus",
 	webmentions: {
 		// Webmention.io API endpoint. Get your own here: https://webmention.io/, and follow this blog post: https://astro-cactus.chriswilliams.dev/posts/webmentions/