search

webforj / webforj-docs

Documentation and code examples for webforJ.
https://docs.webforj.com
0 stars 2 forks source link

Component Basics Admonitions #248

Closed gosteenBASIS closed 1 month ago

gosteenBASIS commented 2 months ago

Closes Issue #73

*** Changes in the update may require the docusaurus instance to be restarted.

Created a "ComponentBasics" component in DocsTools. This is a simple "snippet" admonition to put at the top of Component articles, and it links to the "Component Basics" page under "Building UIs".

As part of this change, I have reworked some of the component management. All the Docs Tools components have been added to the global scope, so you can use them on any pages without specifically importing them. Thus, I have removed all the DocsTools import statements as well.

On my local instance, this change required an npm restart to take effect, and the pages will have errors if the change isn't in effect. So, this pull request may require us to restart the docusaurus instance in order to refresh the global scope that the components are now added to.

gosteenBASIS commented 2 months ago

I removed the ComponentBasics component, and created a "ParentLink" component. Give this component the name of the parent, and it will add an admonition to the page with a link to the enclosing folder of the page. You can set the URL parameter if it needs to link somewhere else. I have added this component to all the List and Field component pages.

gosteenBASIS commented 2 months ago

I've added the DocCardList section at the bottom of the fields and lists articles, and made some wording and language improvements. @MatthewHawkins @bbrennanbasis this is ready for review again.

hyyan commented 1 month ago

@gosteenBASIS make sure to rebase

gosteenBASIS commented 1 month ago

@hyyan I've merged this branch with the website branch, and addressed Ben's comments. I think it's ready for review again.