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

added webCompat as a docs page #690

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

shakyShane
Copy link
Collaborator

@shakyShane shakyShane commented Aug 15, 2023

Added some basic support for documenting Web Compat features - something to build upon

Screenshot 2023-08-15 at 17 17 23 Screenshot 2023-08-15 at 17 17 15

@shakyShane
Copy link
Collaborator Author

shakyShane commented Aug 15, 2023

Current dependencies on/for this PR:

This comment was auto-generated by Graphite.

@jonathanKingston
Copy link
Collaborator

Some errors in the build though.

*
* A suite of individual 'fixes'
*
* - {@link default.windowSizingFix Window Sizing Fix}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Kinda shame we need to do this, is there no other way?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yeah it's not the nicest, but it is checked at build time which makes it slightly better.

another way, would be to encapsulate each sub feature into it's own class/module - but I think that might be going further than you want (in terms of code change for docs).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

or, we can omit the list - it was just a nice way to list them when you land on the top-level webCompat

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't mind, just don't really like having manual steps and loads of boilerplate to make docs happy. I'll let you make the judgement here, I agree splitting to separate classes seems a little overkill too, but I don't mind if there's other benefits.

@shakyShane shakyShane force-pushed the 08-15-added_webCompat_as_a_docs_page branch 2 times, most recently from a5dc2a4 to 5f7f31a Compare September 18, 2023 16:36
@shakyShane shakyShane force-pushed the 08-15-added_webCompat_as_a_docs_page branch from 5c50bb2 to 5140918 Compare September 26, 2023 10:14
@shakyShane shakyShane marked this pull request as draft September 28, 2023 08:29
@shakyShane
Copy link
Collaborator Author

Converted to draft

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.

None yet

2 participants