docs: build out new appium 2 docs interface #1475
Conversation
jlipps
commented
Dec 21, 2022
jlipps
commented
|
here's what the xcuitest driver would look like with its own docs setup. i think it works well! we should probably figure out a linkchecker for the docs since i'm sure there are lots of broken links. we'll want to update a lot of things when final appium 2 docs are published. |
|
there's also a github action we can use to build and publish the docs to github pages on a successful release, which i can figure out when all this is ready to go |
|
(note that i tried to do basically very little actual text editing in this PR, so would prefer that content review/update happens separately.) |
|
Looks promising to me. |
|
@KazuCocoa yeah that's kinda what i'm thinking. the docs for this repo would live at https://appium.github.io/appium-xcuitest-driver |
| configFile, | ||
| }); | ||
|
|
||
| const docsAlreadyExisted = (await m.list()).length >= 1; |
README.md
Outdated
|
|
||
| Next, read the [Full Documentation](https://appium.github.io/appium-xcuitest-driver)! |
There was a problem hiding this comment.
Can we reflect the full TOC in the readme?
There was a problem hiding this comment.
we could, although it would probably need to be maintained by hand and would likely get out of sync if we're not careful. but automatically generating it from the mkdocs metadata would be a decent amount of engineering and i'm not sure it's worth it.
There was a problem hiding this comment.
I assume it might make it easier for users to find what they are looking for...
There was a problem hiding this comment.
Yes, I agree, and if there were an easy way to autogenerate this I would say it's a good idea. But for now clicking through one link before seeing the TOC is probably not an awful experience. it's what a lot of READMEs do for projects that have independent docs sites.
|
Unless there are serious objections, I'm going to plan on merging this as is tomorrow, and publish to the github pages link so the README link is functional immediately after. |
|
ok, docs site is published! |
|
🎉 This PR is included in version 4.16.7 🎉 The release is available on: Your semantic-release bot 📦🚀 |
