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.

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

New Docs Site #124

Closed
wants to merge 152 commits into from
Closed

New Docs Site #124

wants to merge 152 commits into from

Conversation

just214
Copy link
Collaborator

@just214 just214 commented Feb 20, 2021

This PR is primarily responsible for introducing a new VitePress docs site (work in progress) located under the website directory. This new site includes a revamped documentation structure, updated docs, and embedded Typedoc API docs.

The latest version of the site is available here for viewing: https://twind-dev.netlify.app/

Other changes include:

  • Updated Typedoc configuration
  • Removed husky hook temporarily due to inability to commit
  • Removed doctoc commands and dependency
  • Removed original docs and module READMEs
  • Simplified main root README

@sastan
Copy link
Collaborator

sastan commented Feb 20, 2021

Awesome job!!! This is really something. I'll try to put in some time this weekend to get a initial version out as fast as possible. We can then regroup and improve from there.

@sastan sastan mentioned this pull request Feb 20, 2021
4 tasks
@just214
Copy link
Collaborator Author

just214 commented Feb 20, 2021

Thanks! I still plan to do a lot more to update docs and SEO (better descriptions in frontmatter, favicon, etc.) But, I'll give it a break for the weekend and give you a chance to get the initial version launched. Once we have it live, we can sign up for Algolia DocSearch to get the search bar working. Should be as simple as signing up and supplying an API key/index.

@just214
Copy link
Collaborator Author

just214 commented Feb 20, 2021

If there is anything I can do to make this PR easier to merge, please just let me know.

@just214
Copy link
Collaborator Author

just214 commented Feb 20, 2021

Remaining work to be done:

  • Review/complete initial version of the docs
  • Determine the best order of docs and reorder accordingly
  • Add email address to handbook/code-of-conduct.md
  • Register for Algolia DocSearch and supply API key/index to .vitepress/config.js as env var
  • Replace all Typedoc link syntax with internal/external links
  • Update docs frontmatter descriptions for improved SEO
  • Review/update all badges based on changes
  • Sort out CI/CD process for docs (spellcheck, automatic Typedoc builds, etc.)
  • Use twind for styling
  • Add some links back to root README (Frequently viewed docs)
  • Add animated Twind logo to landing page
  • Review head for improvements to SEO
  • Add Favicon, alt images

@sastan
Copy link
Collaborator

sastan commented Feb 20, 2021

Thanks again! I'm currently trying to use the typescript markdown plugin to generate the API docs which would then be used by vitepress. I'll let you know what I come up with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants