Skip to content

docs: split html and js and indicate the new items#7440

Open
CommanderStorm wants to merge 5 commits intomaplibre:mainfrom
CommanderStorm:html-js-split
Open

docs: split html and js and indicate the new items#7440
CommanderStorm wants to merge 5 commits intomaplibre:mainfrom
CommanderStorm:html-js-split

Conversation

@CommanderStorm
Copy link
Copy Markdown
Member

basically, this

image

@CommanderStorm CommanderStorm requested a review from HarelM April 9, 2026 19:50
Comment thread build/generate-docs.ts Outdated
const maplibreUnpkg = `https://unpkg.com/maplibre-gl@${packageJson.version}/`;
const newExamples = getNewExamples();
if (newExamples.size > 0) {
console.log(`${newExamples.size} of ${files.length} examples marked as "new": ${newExamples.map(f => path.basename(f).join(', ')}`);
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Left over?

@HarelM
Copy link
Copy Markdown
Collaborator

HarelM commented Apr 9, 2026

How does the markdown of this looks like?
As far as I understand tabs are not considered regular markdown
for example the following doesn't look like tabs here:

=== Tab1

content

=== Tab2

content 2

So if I'm not mistaken, this is zensical (mkdocs) specific which I would like to avoid to be able to port the docs if needed in the future.

Same for the header.

While I think this is a nice addition to the docs, I think it's not worth the complexity and "vendor lock". sorry... :-/

@CommanderStorm
Copy link
Copy Markdown
Member Author

So if I'm not mistaken, this is zensical (mkdocs) specific which I would like to avoid to be able to port the docs if needed in the future.

Same for the header.

While I think this is a nice addition to the docs, I think it's not worth the complexity and "vendor lock". sorry... :-

if we have another solution we want to migrate to they likey support tabs.
That is super common, even though evryone has their own syntax for how to do this.

Realistically, there will always be coupling to the docs framework. Just have a look at our social cards or how we do admonations..
You change the syntax and move on. No biggie.
This is not like this is a one-way street, we can just remove the feature if it hinders us.

When looking at the examples, they look much more approchable this way if we "hide" the ugly html and show only the js.

Comment thread build/generate-docs.ts Outdated
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.76%. Comparing base (17ae8e3) to head (1a6c6e1).
⚠️ Report is 27 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7440      +/-   ##
==========================================
+ Coverage   92.73%   92.76%   +0.02%     
==========================================
  Files         289      289              
  Lines       24007    24021      +14     
  Branches     5096     5100       +4     
==========================================
+ Hits        22264    22283      +19     
+ Misses       1743     1738       -5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@HarelM
Copy link
Copy Markdown
Collaborator

HarelM commented Apr 9, 2026

You change the syntax and move on. No biggie.

I completely disagree, as I was the person who moved the docs from mapbox's proprietary framework and deleted the docusaurus approach I can tell you that I've worked hard to keep it simple, maintainable, and readable.
I'd like to keep it this way.
The example are searchable from google, and from the website itself.
Adding specific markdown that's not a standard is something I'd like to avoid.
Having all the example in a single place is easy to read, copy and maintain.
I understand the value you are looking to add, don't get me wrong, but I have seen how this gets complicated fast...

@HarelM
Copy link
Copy Markdown
Collaborator

HarelM commented Apr 9, 2026

If the above message sounds too aggressive I'm sorry, I'll be happy to discuss this online if you'd like.

Comment thread build/generate-docs.ts
@HarelM
Copy link
Copy Markdown
Collaborator

HarelM commented Apr 10, 2026

Let's try to find a time to talk about it online please.

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