Adds tabbed content, annotations, and admonitions#30
Adds tabbed content, annotations, and admonitions#30Burhan-Q wants to merge 12 commits intovoxel51:mainfrom
Conversation
|
@Burhan-Q Can you please make an edit to the code in the pr (say update a doc page or something). We just implemented functionality that should build the entire site based on this PR. Doing so will make it easier for us to review changes. |
|
@thesteve0 added some white space, hopefully that helps |
|
Sorry on mobile at the moment, but seems like there's a permission problem |
|
@tom-vx51 Looks like people outside 51 may get the permissions issue |
|
Might need the
|
|
Is the preview action working properly for repo maintainers? I tried using it on my fork (again, trying it all from mobile) and this was the result https://burhan-q.github.io/voxel51-docs/pr-preview/pr-2/ where the |
|
It's a known issue you can't deploy from forks :( - we are investigating a solution that will allow for community builds |
|
@Burhan-Q I have not forgotten this. Waiting on another PR to land before I test this. I think there are too many changes to merge all at once (though I do like them all). I just want to be a bit more deliberate about this.
|
|
I haven't had the time to, but I've been meaning to split this into smaller PRs. My concern with splitting the update to the I was thinking of splitting apart more by page or type of content update. That should make the PR less burdensome (I know the pain, I just had to review a +4000 line PR), but again I just haven't had the time to put into making the split. |
|
No rush and yeah do the mkdocs first. I was about to make some of your changes myself and then I remembered your PR. Do you want me to take on those changes by blatantly stealing your work and then you can just focus on content updates? |
|
Opened a PR with just a quick copy-paste of the |
|
Splitting some of the updates out from this PR into #92 |
|
Handled in separate PRs |





Overview
Proposal to some updates for new docs pages. Specifically for
docs\getting_started\basic\install.mddocs\getting_started\basic\virtualenv.mddocs\fiftyone_concepts\running_environments.mdApologies for the big PR. I intended originally to specifically add the tabbed content, but found several other areas that felt (to me) could use some attention.
Summary of Changes
markdown_extensionsalphabeticallyfrontmatterfor keywords to help surface relevant contentuvshellwhere appropriatejsonwhere appropriatemkdocs.ymlperyaml-linterrors (ignored other errors as it was not obvious that they needed to be fixed)$and>>>from code blocks for consistencyPreview
Admonitions and Tabbed content (expand for screenshot)
Admonitions and Annotations (expand for screenshot)