Skip to content
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

Update the cora documentation to reflect changes in the new theme #695

Open
20 of 30 tasks
SachinPawaskarUNO opened this issue Dec 2, 2023 · 0 comments
Open
20 of 30 tasks

Update the cora documentation to reflect changes in the new theme #695

SachinPawaskarUNO opened this issue Dec 2, 2023 · 0 comments
Assignees
@SachinPawaskarUNO
Labels
documentation enhancement

Comments

@SachinPawaskarUNO
Copy link
Contributor

SachinPawaskarUNO commented Dec 2, 2023 •
edited
Loading

Update the cora documentation to reflect changes in the new documentation UI using theme "material"

  • Add new theme - material
  • Add new light and dark mode
  • Add table of contents
  • Fix broken links
  • Add tablesort functionality for markdown data tables tablesort.js
  • Add includes folder with abbreviations/glossary file abbreviations.md
  • Add assets folder for images and screenshots
  • Ability to view and edit documentation markdown file in GitHub Repository
  • Add favicon and logo
  • Add icons for following features
    • Next Page
    • Previous Page
    • Repository
    • Edit Page in Repo
    • View Page Source
  • Add google analytics for documentation pages
  • Add user feedback for documentation pages
  • Add tooltips feature
  • Add enhanced search capabilities with
    • suggest feature
    • highlight feature
    • share features
  • Add Header autohide feature
  • Add Footer with social buttons
  • Add Git page revisions with
    • Created field
    • Last update field
    • Contributors avatars
  • Add callouts or admonitions feature
  • Create custom callouts/admonitions for Kudos, Instruments, Measurements, Zones
@SachinPawaskarUNO SachinPawaskarUNO self-assigned this Dec 2, 2023
@SachinPawaskarUNO SachinPawaskarUNO moved this to Todo/Backlog in Roadmap Dec 2, 2023
@SachinPawaskarUNO SachinPawaskarUNO changed the title Update the cora documentation to reflect changes in the new UI Update the cora documentation to reflect changes in the new documentation UI Dec 4, 2023
@SachinPawaskarUNO SachinPawaskarUNO changed the title Update the cora documentation to reflect changes in the new documentation UI Update the cora documentation to reflect changes in the new theme Dec 4, 2023
SachinPawaskarUNO added a commit that referenced this issue Dec 4, 2023
@SachinPawaskarUNO
add tablesort.js for data tables, related to #695
7ad7f3d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SachinPawaskarUNO SachinPawaskarUNO

Labels
documentation enhancement
Projects
Roadmap
Status: Todo/Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@SachinPawaskarUNO