Provide API examples documentation #54
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
6 tasks
fajar-apri-alaska
force-pushed
the
fajarapri/modernizeDocs
branch
from
76d6031
to
eeb7fc4
Compare
jordanjones243
requested changes
Feb 2, 2024
fajar-apri-alaska
force-pushed
the
fajarapri/modernizeDocs
branch
2 times, most recently
from
5781c89
to
9169d76
Compare
jordanjones243
force-pushed
the
fajarapri/modernizeDocs
branch
2 times, most recently
from
99c30fa
to
5ac1ed3
Compare
Changes to be committed: modified: README.md new file: apiExamples/basic.html new file: apiExamples/custom-content.html new file: apiExamples/error-multiline.html new file: apiExamples/error-no-icon.html new file: apiExamples/error.html new file: apiExamples/fixed-pixels.html new file: apiExamples/hidden-audible.html new file: apiExamples/hidden-visually.html new file: apiExamples/hidden.html new file: apiExamples/information-multiline.html new file: apiExamples/information-no-icon.html new file: apiExamples/information.html new file: apiExamples/role.html new file: apiExamples/success-multiline.html new file: apiExamples/success-no-icon.html new file: apiExamples/success.html new file: apiExamples/warning-multiline.html new file: apiExamples/warning-no-icon.html new file: apiExamples/warning.html new file: demo/api.html new file: demo/api.md modified: demo/demo.md modified: demo/index.html new file: docs/partials/api.md new file: docs/partials/demo.md new file: docs/partials/description.md new file: docs/partials/readmeAddlInfo.md new file: docs/partials/useCases.md modified: package-lock.json modified: package.json new file: scripts/generateDocs.mjs
- also rename demo.md to index.md with some other file that refer to the file. Changes to be committed: new file: apiExamples/custom.html modified: demo/index.html renamed: demo/demo.md -> demo/index.md modified: docs/partials/api.md deleted: docs/partials/demo.md new file: docs/partials/index.md modified: scripts/generateDocs.mjs
blackfalcon
force-pushed
the
fajarapri/modernizeDocs
branch
from
5ac1ed3
to
6d579af
Compare
This commit adjusts content in the demo and api examples files. Also updates the file names to the current spec. Also removed the fixed-pixels demo and API content as this feature is deprecated. The role API content and the demo was also removed as this is a private internal API feature. Changes to be committed: modified: README.md deleted: apiExamples/fixed-pixels.html deleted: apiExamples/role.html modified: apiExamples/warning-no-icon.html modified: demo/api.html renamed: demo/api.md -> demo/apiExamples.md modified: demo/index.md modified: docs/api.md deleted: docs/partials/api.md new file: docs/partials/apiExamples.md modified: docs/partials/index.md modified: scripts/generateDocs.mjs modified: src/auro-alert.js
blackfalcon
force-pushed
the
fajarapri/modernizeDocs
branch
2 times, most recently
from
8c1f461
to
fbec107
Compare
Changes to be committed: modified: package-lock.json modified: package.json
blackfalcon
force-pushed
the
fajarapri/modernizeDocs
branch
from
fbec107
to
b0d00ef
Compare
blackfalcon
approved these changes
Feb 8, 2024
|
🎉 This PR is included in version 2.1.4 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Alaska Airlines Pull Request
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Resolves: AuroDocsite#167
Summary:
demo.mdtoindex.mdand all references to the file.Type of change:
Please delete options that are not relevant.
Checklist:
By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.
Thank you for your submission!
-- Auro Design System Team