Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove 'coreconcepts-' prefix from styles, admonition blocks, etc #438

Merged
merged 10 commits into from
Mar 26, 2024

Conversation

pdaoust
Copy link
Collaborator

@pdaoust pdaoust commented Mar 25, 2024

There are some template elements called coreconcepts-intro, coreconcepts-orientation, etc. The naming is a legacy from when they were only used on the core concepts pages, but now they're getting used in other places too.

There are a couple places where they show up:

  • The Markdown parser has been extended to recognise them as special blocks that deserve their own styling
  • There are matching CSS styles

This is just a simple search-and-replace. Update: see below. I'm pretty sure the shortened names don't clash with anything.

Update

I found out the styles weren't hooked up to these block containers anyway, so I've done some work to make them work. You can see all three at work in e.g., https://deploy-preview-438--developer-portal-production.netlify.app/concepts/7_validation/

One big change is that the big ::: storysequence block has been changed to more verbose, but much simpler and less magical, ::: storystep blocks around each step in a story sequence. I don't think we'd ever reimplemented the original site's behavour, in which each step was a list item.

@pdaoust
Copy link
Collaborator Author

pdaoust commented Mar 25, 2024

okay, this is weird... I just discovered that these special Markdown blocks get custom markup and styles, but never the twain do meet -- the styles live in a file that never gets loaded by any page!

src/scss/_blocks.scss Outdated Show resolved Hide resolved
src/scss/_blocks.scss Outdated Show resolved Hide resolved
Copy link
Member

@mattyg mattyg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted a few potential styling tweaks (I don't have a good design sense so feel free to ignore).

Also I see that the Get Started page and Resources page have "intro" text that isn't tagged for the intro styling.

@pdaoust pdaoust force-pushed the chore/rename-coreconcepts-elements branch from 2649a18 to 9f034ec Compare March 26, 2024 21:06
@pdaoust pdaoust merged commit ccff3dc into main Mar 26, 2024
6 checks passed
@pdaoust pdaoust deleted the chore/rename-coreconcepts-elements branch March 26, 2024 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants