Anton Maximov and his team at Coast tried a lot of documentation tools before deciding on Slab. Google Docs — Without cross linking or an easy way to structure information, it was too hard to find information 😓 In-house tool/GitHub — As engineers, it made sense to try reading documentation as code in GitHub, but search was limited and there was too much friction in creating documentation 😬 Confluence — Considered, but when they couldn't import their Markdown pages and realized they'd have to build an importer or rewrite their docs, it was a no go 😫 And then a friend recommended Slab to Anton, and once he discovered he could import all their Markdown files directly, and it was easy to create, organize, and read documentation… well the rest is history 😉 ✨ https://lnkd.in/gvRX5_Ku
Slab’s Post
More Relevant Posts
-
🤔 How do you assign reviewers for PR/MRs? I’ve seen teams do many different things here: - Assign the entire GitHub squad and let GitHub choose a reviewer based on round robin or load balancer algorithms. - Using codeowners to automatically assign reviewers based on the files changed. - Dropping the PR link into a team channel and hope someone will review it. - Always assigning the same person as a reviewer. ❓ We’ve been thinking into developing a feature for choosing the best reviewer based on git blame, the PR diffs and the workload of teammates. Do you think it would we useful?
To view or add a comment, sign in
-
For engineering teams, one of the trackable metrics is GitHub commits. This blog post provides a tutorial to guide you through the process of utilizing GitHub's API to retrieve and display GitHub commit data in a real-time, interactive graph. https://buff.ly/3WofhwE
To view or add a comment, sign in
-
-
what are the readthedocs website used for ? https://lnkd.in/dKjU_kQi Read the Docs is an open-sourced free software documentation hosting platform. It generates documentation written with the Sphinx documentation generator, MkDocs, or Jupyter Book. #documentation #unittest #webdevelopment #webdeveloper #codeigniter #laravel
To view or add a comment, sign in
-
Learn how to create a Docs site using GitHub and a Jekyll static site in this article: https://lnkd.in/gjPF_nTb #github #docs
To view or add a comment, sign in
-
Recently, I had the opportunity to guide a team through integrating their company emails with their GitHub accounts and setting up Git for project-specific work. I had done the same for multiple projects but just realized that it would be more efficient to have a memo :-) So, here is a blog post that breaks down the steps. It's not rocket science, but I trust it must be helpful. Whether you're balancing multiple projects or just looking to keep your professional contributions separate, this guide might offer some useful pointers. https://lnkd.in/dFEpmMhj
Using a Company Email with Your GitHub Account — A Step-by-Step Guide
varya.me
To view or add a comment, sign in
-
Award-winning journalist and data scientist, now newly retired. Happily embarking on my next chapter.
Useful tips for using GitHub Copilot AI-powered code completion from Christopher Harrison, senior developer advocate at GitHub: (❤️ the term comment-driven development!) Describe the goal. Start a file with a few lines of comments highlighting what you're building. Be flexible. If you don't see what you want, rephrase the comment. Provide examples. If you're processing data, show the start and end points you expect.
To view or add a comment, sign in
-
-
Check out the Github resources below for how to grow as an Engineer! Thanks Jordan Cutler and Zach Wilson for helping to upskill the community
Senior Software Engineer @ Pinterest | Author of High Growth Engineer Newsletter | Course Instructor
I created a public Github repo with all the resources, books, newsletters, and social media accounts you should be following to grow to Senior Engineer and beyond. Inspired by Zach Wilson's Data Engineering Handbook. I'm accepting PRs so we can crowdsource this effort and have a really comprehensive list of resources! Like, repost, share to spread the word and make this as awesome as possible for everyone. https://lnkd.in/evcPd-pN
GitHub - jordan-cutler/path-to-senior-engineer-handbook: All the resources you need to get to Senior Engineer and beyond
github.com
To view or add a comment, sign in
-
Why I built this CLI tool to explore complex repositories? The video shows a demo of this tool. The git-discover is a CLI tool that will help you go through any open-source repository on GitHub. Open-source repositories are fairly complex if you are new to a project. You definitely cannot understand the code just by looking through it. It takes weeks or probably months to understand those projects. I was in the same situation while going through express source code. So, I have built this tool to help me to go through any repositories on GitHub quickly from the start. GitHub allows you to select the date and filter the commits, but I felt it was too slow for me to go through each commit. So I wanted something quick that is the reason I started building git-discover. The link to the repository is in the comment section. I know there is a lot to improve. It is just the initial version.
To view or add a comment, sign in
-
How can I use Git to push my code to a GitHub repository? To get started, you need to create an empty repository using GitHub. You can do this by visiting https://lnkd.in/dEfdPNSh. Type in your cmd ⌨: 1. git init 2. git add . "The dot means add all the files" 3. git status - GREEN: If you get a green file, you have successfully added it. - RED: It means that you have either edited a file or removed it. 4. git commit -m "first commit" - M is a flag (shortcut) for --move --force per the docs page on the Git branch. 5. git remote add origin https:// username / repo name - You can Copy the link from your GitHub repo 6. git push -u origin master -U flag is used to set origin as the upstream remote in your git config, so git pull can be used without any arguments in the future.
Quickstart for repositories - GitHub Docs
docs.github.com
To view or add a comment, sign in
-
A nice list of resources for anyone looking to progress in their careers.
Senior Software Engineer @ Pinterest | Author of High Growth Engineer Newsletter | Course Instructor
I created a public Github repo with all the resources, books, newsletters, and social media accounts you should be following to grow to Senior Engineer and beyond. Inspired by Zach Wilson's Data Engineering Handbook. I'm accepting PRs so we can crowdsource this effort and have a really comprehensive list of resources! Like, repost, share to spread the word and make this as awesome as possible for everyone. https://lnkd.in/evcPd-pN
GitHub - jordan-cutler/path-to-senior-engineer-handbook: All the resources you need to get to Senior Engineer and beyond
github.com
To view or add a comment, sign in