Tightknit Community Icon

Learn All About Tightknit on Our New Docs Website | Open Source & Constantly Updated

Avatar of Stephen Cook
Stephen Cook
January 10, 2024

Reading time: 1 minute

docs3.jpeg

📚 Learn the ins and outs of Tightknit on our new docs website! Here it is folks, our brand new documentation site: https://docs.tightknit.ai Can't remember how channel descriptions are synced to the Tightknit site? Want to know how to configure feeds? Need a description of the pages in your site? Don't know where to start? It's all here and constantly getting updated! And here's a fun bonus: it's open source. Yes, the entire Tightknit docs website is open source. You can of course always leave feedback with us to revise and improve our documentation, but if you are really getting bugged by that one typo and feel so inclined... you can contribute back to the Tightknit community! Just open a pull request on Github and we'll take a look. 🙏

  • Avatar of Zach Hawtof
    Zach Hawtof
    ·
    ·

    Finally! Also huge thank you to our docs platform Nextra for being so easy to set up.

  • Avatar of Zach Hawtof
    Zach Hawtof
    ·
    ·

    Stephen Roland tagging you a bunch today but could use your eventual feedback on best practices for documentation!

  • Avatar of Stephen Roland
    Stephen Roland
    ·
    ·

    No worries! Excited to be a part of the community and help out where I can. These docs look great! I think open sourcing them and allowing users to have input is fantastic. What we see with docs a lot is that the pain usually lies in generating the initial docs (which you crushed!) and then in maintaining them. As products and features change, particularly with technical products / docs, then the docs become out of date and/or irrelevant, which can lead to a negative user experience.

  • Avatar of Stephen Roland
    Stephen Roland
    ·
    ·

    TL;DR: prioritizing the docs before launching a new feature and keeping the docs up to date are very important. The longer one puts it off the longer the to do list becomes.

  • Avatar of Zach Hawtof
    Zach Hawtof
    ·
    ·

    Great insight! Thanks for sharing. Ya the initial docs was a full day grind but we’re glad we have that to fall back on now

  • Avatar of Stephen Cook
    Stephen Cook
    ·
    ·

    Good documentation is near and dear to my soul, so we're committed to keeping them up to date to the best of our ability!

  • Avatar of Zach Hawtof
    Zach Hawtof
    ·
    ·

    Stephen Cook is being modest. He once won an industry award at Salesforce for the docs on our product there.

  • Avatar of Stephen Roland
    Stephen Roland
    ·
    ·

    Legendary!