Skip to content

📝 Overhaul of Legerity documentation #180

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.

Sign up for GitHub

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

Jump to bottom
Merged
jamesmcroft merged 37 commits into from
Dec 23, 2022
Merged

📝 Overhaul of Legerity documentation #180

jamesmcroft merged 37 commits into from
Dec 23, 2022

Conversation

@jamesmcroft
Copy link
Member

@jamesmcroft jamesmcroft commented Nov 30, 2022

Resolves #179

This change will introduce a brand-new suite of articles in the Legerity documentation to aid developers adopting the framework for writing great UI tests for their applications.

PR checklist

  • Have Legerity sample tests been added or updated, run locally, and all pass
  • Have added or updated support for platform specific element wrappers been reflected in the Page Object Generator
  • Have code styling rules been run on all new source file changes
  • Have relevant articles in the docs been added or updated for all new source file changes
  • Have major breaking changes been made and are documented

Other information

jamesmcroft added 30 commits April 5, 2022 07:16
@jamesmcroft
Updated docs with internal links to API docs for element wrappers
61e3b12
@jamesmcroft
Merge branch 'main' into feature/docs
eaa4e23
@jamesmcroft
Merge branch 'main' into feature/docs
9d74903
@jamesmcroft
📝 Added new iconography for docs homepage
330c22e
@jamesmcroft
📝 Updated styling to include Bootstrap
5c4c61d
@jamesmcroft
📝 Updated docs homepage with new content
0c8d2a1
@jamesmcroft
📝 Fixed cross-reference linking to introduction page from homepage
2071a61
@jamesmcroft
📝 Added new getting started page and base pages for quick starts
529f51b
@jamesmcroft
📝 Updated homepage links to using Legerity pages
61ba56d
@jamesmcroft
📝 Fixed cross-referencing to using Legerity from Getting Started and …
9d2d2b0 
…Intro
@jamesmcroft
📝 Added structure for using Legerity pages
2ed4902
@jamesmcroft
📝 Updated link styling for docs pages
cb68507
@jamesmcroft
📝 Added base page for Installation docs
a1e5021
@jamesmcroft
📝 Added pre-reqs for Windows quick start
4625436
@jamesmcroft
📝 Temporary archive for previous docs
d031b02
@jamesmcroft
Merge branch 'main' into feature/docs
7350399
@jamesmcroft
📝 Updated documentation for Windows quick start using template
4e2b663
@jamesmcroft
📝 Updated reference page linking for Windows quick start
0ae0f2e
@jamesmcroft
📝 Added skeleton for wait condition docs
4f747cc
@jamesmcroft
📝 Added quick start for Android
3763285
@jamesmcroft
📝 Added quick start guide for iOS
b8947b8
@jamesmcroft
📝 Added web quick start guide
55a9344
@jamesmcroft
📝 Updated supported browser drivers in web quick start
9351ae7
@jamesmcroft
📝 Added quick start guide for cross-platform tests
c4f9aab
@jamesmcroft
📝 Fixed broken xref link from quick start to using Legerity docs
1ea45f3
@jamesmcroft
📝 Added list of ordered topics to Using Legerity page
9b91365
@jamesmcroft
📝 Fleshed out content for installing Legerity
93bb4d1
@jamesmcroft
📝 Added documentation on test framework specifics
0bac8ca
@jamesmcroft
📝 Added docs for Legerity base test class
5b99a3d
@jamesmcroft
📝 Updated documentation on test classes with the AppManager
5ce71fe
@jamesmcroft jamesmcroft marked this pull request as ready for review December 23, 2022 10:22
@jamesmcroft jamesmcroft requested a review from a team as a code owner December 23, 2022 10:22
@jamesmcroft jamesmcroft merged commit a96729c into main Dec 23, 2022
@jamesmcroft jamesmcroft deleted the feature/docs branch December 23, 2022 10:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tom-made tom-made tom-made approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Feature] Documentation re-write

3 participants

@jamesmcroft @tom-made