FusionAuth
refactor(breadcrumb): replace 'strong' with 'breadcrumb' tags
thanks for the review @tonyblank while merging the latest updates i found a mistake in a few changes we did where it should have been replaced with <UIelement></UIelement> instead.
@alex-fusionauth I've merged the latest changes and updated some newly introduced <strong> tags and we are ready to merge. As discussed, while reviewing for any other changes the single step navigation instructions. I've update all these accordingly as well with the <Breadcrumb> tag.
The few ones unclear right now are the ones where it refers to navigate to a section rather a full page/tab.
Here is a file of lines that in most cases need <Breadcrumb> instead of some other styling. A few need <InlineUIElement>.
breadcrumbs-needed.txt
Here is a file of lines that in most cases need
<Breadcrumb>instead of some other styling. A few need<InlineUIElement>. breadcrumbs-needed.txt
@andrewpai Working on this at the moment, and wanted to clarify, we will not only change the site content but all blog posts too with the same concept. And according to that i will update the blog section in DocsDevREADME.md with that guideline too.
Here is a file of lines that in most cases need
<Breadcrumb>instead of some other styling. A few need<InlineUIElement>. breadcrumbs-needed.txt@andrewpai Working on this at the moment, and wanted to clarify, we will not only change the site content but all blog posts too with the same concept. And according to that i will update the blog section in DocsDevREADME.md with that guideline too.
Correct, we should make our docs consistent across /docs, /blog, and /articles.
@andrewpai can we consider a read-only field still a InlineField or is InlineUIElement preferred? The most common case is the ID field which can be at different stages either of it.
And further specifying fields would be good too: can we define all types of form fields e.g. text, drop-down selection, checkbox considered InlineField, defining it as where ever info is being entered?
If it comes to the field input, it isn't standardized at the moment we have <strong>, *, **, `, ", and in few places just text at the moment. Could this be a new definition e.g. InlineFieldInput?
@andrewpai can we consider a read-only field still a InlineField or is InlineUIElement preferred? The most common case is the ID field which can be at different stages either of it.
And further specifying fields would be good too: can we define all types of form fields e.g. text, drop-down selection, checkbox considered InlineField, defining it as where ever info is being entered?
If it comes to the field input, it isn't standardized at the moment we have
\<strong\>,*,**,,"`, and in few places just text at the moment. Could this be a new definition e.g. InlineFieldInput?
Sorry, I completely missed this. InlineField was created so we could reference a field in an API request or response along with its various annotations, inline to some text vs. called out on its own line. I'm not sure if the read-only field fits that description, but if so then I think InlineField is appropriate. If it isn't a field used in an API then maybe InlineUIElement is better.
Thanks @andrewpai,
We will go ahead and define a read-only form field as InlineField as it is still a form field. https://github.com/FusionAuth/fusionauth-site/blob/d73546e80cfe4274d0132ac2fd3e991f9479b633/DocsDevREADME.md?plain=1#L42
If it comes to the field input, we go ahead and use the <strong> tag everywhere unless you want to create a custom tag.
Thanks @andrewpai,
We will go ahead and define a read-only form field as InlineField as it is still a form field.
https://github.com/FusionAuth/fusionauth-site/blob/d73546e80cfe4274d0132ac2fd3e991f9479b633/DocsDevREADME.md?plain=1#L42
If it comes to the field input, we go ahead and use the
<strong>tag everywhere unless you want to create a custom tag.
@andrewpai We discovered the issue that linting will complain about the usage of <strong> tags in mdx files:
> [email protected] lint
> eslint src/content/blog/swift-sdk-beta.mdx src/content/docs/sdks/android-sdk.mdx src/content/docs/sdks/swift-sdk.mdx src/content/quickstarts/quickstart-swift-ios-native-appauth.mdx src/content/quickstarts/quickstart-swift-ios-native.mdx
/home/runner/work/fusionauth-site/fusionauth-site/astro/src/content/quickstarts/quickstart-swift-ios-native.mdx
63:56 error Unexpected HTML tag [strong], use markdown instead remark-lint-no-html
63:139 error Unexpected HTML tag [strong], use markdown instead remark-lint-no-html