Switch to Starlight

[julien-deramond]

All

• Meta information for all pages
  • Update after Deleting unnecessary twitter meta tags, quick fixes withastro/starlight#2137 is released
• Compare generated sitemap and production sitemap

Details

• https://openresource.dev/books/ → https://openresource.dev/resources/books/
• https://openresource.dev/events/ → https://openresource.dev/resources/events/
• https://openresource.dev/open-sourcerers/ → https://openresource.dev/resources/open-sourcerers/
• https://openresource.dev/podcasts/ → https://openresource.dev/resources/podcasts/
• New: https://openresource.dev/articles/2/ → Articles pagination
• New: several https://openresource.dev/articles/tags/* pages (blog)
• New: https://openresource.dev/guide/creating-your-own-open-source-project/contributing-your-project-to-the-open-source-community/: content coming soon
• New: https://openresource.dev/guide/financing-open-source-projects/fostering-a-sustainable-ecosystem/: content coming soon
• New: https://openresource.dev/guide/financing-open-source-projects/resource-allocation-and-budgeting/: content coming soon
• New: https://openresource.dev/guide/financing-open-source-projects/transparency-accountability-and-community-involvement/: content coming soon
• New: https://openresource.dev/guide/maintaining-open-source-projects/ensuring-project-sustainability/: content coming soon
• New: https://openresource.dev/guide/maintaining-open-source-projects/managing-contributions-and-community-engagement/: content coming soon
• New: https://openresource.dev/guide/maintaining-open-source-projects/managing-project-dependencies/: content coming soon
• New: https://openresource.dev/guide/promoting-open-source-projects/crafting-an-engaging-project-website/: content coming soon

• Update src/content/docs/fr (or delete for now the fr version)
• Markdown blockquotes rendering: no italic and no double quotes at the beginning/end?
• Reading bar at the top of the screen
• Visible focus: double black/white outline
• Feedback from the community: drop the 2 asides at the bottom of the guide pages and replace them with something lighter

Guide

Check out done tasks list

• Reintegrate all the pages (modules, and chapters)
  • What Is Open Source?
  • Getting Started with Open Source
  • Contributing to Open Source Projects
  • Creating Your Own Open-Source Projects
  • Maintaining Open-Source Projects
  • Promoting Open-Source Projects
  • Financing Open-Source Projects
• For all chapters, integrate the creationDate and lastUpdateDate as date and lastUpdated
• For all chapters, integrate the reading time
• For all chapters, display the creation date?
• For the guide and/or module, integrate the total reading time
  • Change the way it's displayed, find something better than "This guide will take you approximately xx min to read"
• Chapters like /docs/guide/creating-your-own-open-source-project/contributing-your-project-to-the-open-source-community.mdx could have a soon: true in the frontmatter.
• Modify <div> with sponsor button in /docs/guide/financing-open-source-projects/understanding-funding-models.mdx

Articles

• Transform the articles into a blog and test https://github.com/HiDeoo/starlight-blog
• Reintegrate all articles
• Include reading time
• Drop all draft: true from articles when ready
• Add footer for articles (how?)
  • At least, "Edit page" is missing
• Replace all excerpt: "TODO" by real content
• Add meta description for all articles
• Add RSS for the articles + add RSS in the left sidemenu
  • RSS: how to have the excerpt used in the RSS instead of the entire blog article → postponed in RSS: how to use the excerpt in the RSS feed #883
• Possible to change /resources/events to be /events? Even when keeping the "Resources" sidebar section? Or at least redirect the previous URLs?
• List of articles + equivalent content/rendering
  • Bluesky Starter Pack About Open Source
  • Who Is the Ghost User on Github?
  • contrib.rocks: Generate an Image of GitHub Repositories Top Contributors
  • Repobeats: GitHub README analytics
  • GitHub Marketplace: Social Preview for Your GitHub Actions
  • Display Your Sponsors in Your GitHub READMEs
  • Can I Take This Issue?
  • How to Create a Code of Conduct for an Open-Source Project

Resources

Check out done tasks list

• All resources pages
  • Books
  • Events
  • Open Sourcerers
  • Podcasts

Other pages

• Reintegrate all the pages
  • Homepage
    • Footer
  • About author
  • Cookie policy
  • Showcase
    • Add the extra information in cards? languages, etc. (for that, must create a dedicated card): postponed to Showcase: Add extra information #884

Other sub-tasks

• Check https://github.com/HiDeoo/starlight-showcases + feat: adds new <ShowcaseProfile> component to showcase profiles like GitHub users, repositories or any other profile HiDeoo/starlight-showcases#6
• Check that all newly integrated commands in README.md are all working
• Homepage mobile view (socials, languages selector, theme selector): Splash template on mobile unable to access social/theme/language menu withastro/starlight#977

Before merging

• Re-run locally all npm run commands
• Double-check and compare each and every metadata information to be sure to not forget anything → Postponed to Compare metadata with previous version of the website #885

Things that could be improved later on

• Enable multi-languages and translate everything in French → Enable multi-languages and translate the content to French #886
• Center images in guide and articles → Center images in the guide and articles #890
• Test https://github.com/florian-lefebvre/satori-astro/blob/main/package/README.md to check that it's easier to truncate description that are too long. → Try florian-lefebvre/satori-astro for Open Graph images #891
• Use <LinkButton> instead of our custom Button.astro? → Use Starlight <LinkButton> instead of our <Button> #892

Guide

• For the guide and/or module, integrate the total reading time
  • Improve the <GuideReadingTime slug="guide/financing-open-source-projects" /> interface so that the slug can be found automatically based on where the component is used (find its own context) → Improve <GuideReadingTime> interface #887
• The warning message at the end of /docs/guide/creating-your-own-open-source-project/legal-considerations.mdx for instance, could be a finished: false in the frontmatter. → Add a finished: false parameter to the frontmatter #888

Articles

• Add cover for all articles? (see https://starlight-blog-docs.vercel.app/guides/frontmatter/) → Add a cover for all articles #889

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
main-branch-openresource-dev	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 12, 2024 5:48pm