Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

Display "Used by" data on the Showcase page for GtiHub repositories.

Example in the following screenshot provided by GitHub assets:

Motivation and context

This information can be really useful to see if the project is actually already used or not without going to GitHub.

Description

[email protected] introduced a way to add a background image to Open Graph images.

We could enhance the rendering of our Open Graph to have some more details.

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

Drop useless "Show project(s)" link in https://www.openresource.dev/showcase.

ShowcaseBanner.astro might have a new parameter to display or not this button link.

Motivation and context

This link has its own page as the target, so it's useless!

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

Add something like the following on the page as done by Google Docs:

Motivation and context

When the content is long, it can be really useful to be able to jump to a specific section (especially if you've already read the content).
Can also be useful for fast readers who analyze the content structure before reading it.

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

This issue suggests removing @tailwindcss/typography which is difficult to maintain when we bump dependencies (even for a patch release where rendering can be broken and not easily identifiable).

The aim is to have exactly the same rendering. Should be easily doable with Tailwind and Astro components.

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

The idea here would be to find a new name for our articles that are not really articles.
I see them atm more like zooms or focuses that could be linked within the guide to go more in-depth into the topic, and its modules/chapters.

Motivation and context

Better clarity and readability for readers.

astro v2.5.0

Content collections now support data formats including JSON and YAML. You can also create relationships, or references, between collections to pull information from one collection entry into another.

Study if this new support can be used in this repository.

astro v2.7.0 introduced a feature allowing to split the SSR build into multiple files.

This issue is a study to check if this build option could be helpful in this project to improve performance. If this is the case, it can be implemented in a Pull Request closing this issue.

astro v2.5.0

Adds an opt-in way to minify the HTML output.

Using the compressHTML option Astro will remove whitespace from Astro components. This only applies to components written in .astro format and happens in the compiler to maximize performance. You can enable with:

import { defineConfig } from 'astro/config';

export default defineConfig({
 compressHTML: true,
});

Compression occurs both in development mode and in the final build.

Study if this compression can be useful in this repository.

Feedback provided by @HiDeoo

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

Using a grid to get identical widths for the next/previous buttons in chapters could make the rendering a little bit better.

Motivation

Since this project doesn't have a defined design system, the rules are not yet written and precise. While I'm not sure forcing the width will always be the right solution, in this specific case, it might indeed be better in terms of rendering.

Let's try it!

Astro 2.6.0 introduced Hybrid SSR Output Mode defaulting to static pre-rendering.

This issue suggests studying this new Astro feature, and evaluating what could be done in openresource.dev.
A PR can directly be opened with the result of this study if useful modifications can be done.

Structured data has been added for our articles via #225.

The idea here is to do the same for our guide.

However, I'm not sure which type of structured data we need to use for our guide modules and chapters; maybe Course 🤷
What do you think?

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

Find the right layout to display the links in the footer to avoid the following at small breakpoints:

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

Right now, Open Graph images are generated only for what's contained within /src/content. It means that all the Astro pages in src/pages have static images created manually via a Figma template (see https://github.com/Open-reSource/openresource.dev/pull/289/files).

The idea would be to do the exact same thing for src/content but with Astro pages.

Motivation and context

The main motivation is to provide easier maintenance. If a new page is created or that the title or description of an existing page is modified, the image must be recreated manually.

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

Display programming languages data on the Showcase page for GtiHub repositories.

Example in the following screenshot provided by GitHub assets:

The languages could be a stacked progress bars like in this screenshot or a list of colored labels, or even something else.

Motivation and context

This information can be useful for the community to find Open Source to contribute to.

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

Right now, guide chapter descriptions are not visible in Open Graph images. It can be seen for example in https://www.opengraph.xyz/url/https%3A%2F%2Fopenresource.dev%2Fguide%2Fwhat-is-open-source%2Fdefinition-of-open-source.

This is due to a difference of description management which is inconsistent in the code where some descriptions are handled, but also meta descriptions.

Motivation and context

Open Graph images are working in all cases.

Astro 2.6.0 introduced CSS inlining for small snippets of CSS.

This issue suggests studying this new Astro feature, and evaluating what could be done in openresource.dev.
A PR can directly be opened with the result of this study if useful modifications can be done.

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal / Motivation and context

There's not much to describe here, a skip link should be added to the website for obvious reasons.

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

97b27ba removed the Sitemap semi-advanced generation because the content was not correct since the modification date was global to the website.

It doesn't seem possible right now but the idea of this feature request would be to use the data stored in the frontmatter for articles, chapters, modules, etc. to have the right lastmod value in the sitemap.

serialize function in @astrojs/sitemap seems to be the best shot right now but doesn't seem to allow to get info from the frontmatter.

Motivation and context

changefreq and priority are ignored by Google but it is probably not the case for lastmod even if I'm not certain about it. Hopefully it would help with the SEO of the website.

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

Right now, links showcased at https://openresource.dev/showcase are displayed following the order of https://github.com/orgs/Open-reSource/discussions/3. When the website is built, this order should be random.

Motivation and context

Better equity for links to be displayed first.

Prerequisites

• I have searched for duplicate or closed feature requests
• I have read the contributing guidelines

Proposal

In HeadSEO.astro, we deduce the URL of the static images (not generated automatically) from the URL:

However, we aren't sure that this image really exists.

The idea would be to throw an error when running npm run build to inform the developer that the image is missing.

⚠️ This would be a temporary solution waiting for #290 to be implemented. Because, in that case, this system would be useless.

Motivation and context

Avoid having Astro pages without Open Graph images.

Prerequisites

• I have searched for duplicate or closed issues
• I have read the contributing guidelines

Describe the issue

I noticed that depending on the theme, the current selection colors works relatively well (mostly on light themes), but can also sometimes makes some elements like titles difficult to read (mostly on dark themes) and also sometimes makes the text even more difficult to read (e.g. the coffee theme).

Some browsers (e.g. Firefox ^^) will even fail to render properly some elements with some themes, for example a selected title with the Dark theme (which can be a default) on Firefox 112.0.2.

I think it would be nice to fix these issues specially considering that some people use selections to track their reading progress. I suggest the following changes to src/global.css:

+ ::selection {
+   background: hsl(var(--p));
+   color: hsl(var(--pc));
+ }

This changes uses DaisyUI CSS variables to use the primary color and its content variation for the selections. I think this works relatively well with all themes.

Here is a (large) screenshot of a comparison (using Chrome) between the current state (left) and the proposed changes (right) on various themes:

I am willing to submit a pull request if you think this is a good idea or discuss further if you have any concerns or suggestions.

What operating system(s) are you seeing the problem on?

All

What browser(s) are you seeing the problem on?

All