[PR #1107] [MERGED] Development documentation #3443

Closed
opened 2026-04-25 00:15:40 +02:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/advplyr/audiobookshelf/pull/1107
Author: @ruoti
Created: 11/1/2022
Status: Merged
Merged: 4/4/2023
Merged by: @advplyr

Base: masterHead: dev-documentation


📝 Commits (1)

  • 6dc4dc8 Updating devcontainer setup and related documentation

📊 Changes

9 files changed (+273 additions, -16 deletions)

View changed files

📝 .devcontainer/Dockerfile (+14 -3)
.devcontainer/dev.js (+9 -0)
📝 .devcontainer/devcontainer.json (+37 -9)
.devcontainer/post-create.sh (+29 -0)
.gitattributes (+5 -0)
📝 .gitignore (+2 -2)
.vscode/launch.json (+44 -0)
.vscode/tasks.json (+40 -0)
📝 readme.md (+93 -2)

📄 Description

As requested in #259, I have tried to create documentation about setting up the development environment and running this project. As part of this effort, I also updated the .devcontainer used by visual studio code. For this, I regenerated the base configuration using VSCode, then added the necessary modules based on the Dockerfile in the root directory. I also added post-build commands to ensure everything was setup for new users. Finally, I added VSCode build/test tasks and debug targets.

If people use the dev container, it takes running one command in VSCode and hitting F5 before they are running the code for the first time, which is pretty nice.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/advplyr/audiobookshelf/pull/1107 **Author:** [@ruoti](https://github.com/ruoti) **Created:** 11/1/2022 **Status:** ✅ Merged **Merged:** 4/4/2023 **Merged by:** [@advplyr](https://github.com/advplyr) **Base:** `master` ← **Head:** `dev-documentation` --- ### 📝 Commits (1) - [`6dc4dc8`](https://github.com/advplyr/audiobookshelf/commit/6dc4dc8f4926788a4dbff1f1e42e131993e02887) Updating devcontainer setup and related documentation ### 📊 Changes **9 files changed** (+273 additions, -16 deletions) <details> <summary>View changed files</summary> 📝 `.devcontainer/Dockerfile` (+14 -3) ➕ `.devcontainer/dev.js` (+9 -0) 📝 `.devcontainer/devcontainer.json` (+37 -9) ➕ `.devcontainer/post-create.sh` (+29 -0) ➕ `.gitattributes` (+5 -0) 📝 `.gitignore` (+2 -2) ➕ `.vscode/launch.json` (+44 -0) ➕ `.vscode/tasks.json` (+40 -0) 📝 `readme.md` (+93 -2) </details> ### 📄 Description As requested in #259, I have tried to create documentation about setting up the development environment and running this project. As part of this effort, I also updated the .devcontainer used by visual studio code. For this, I regenerated the base configuration using VSCode, then added the necessary modules based on the Dockerfile in the root directory. I also added post-build commands to ensure everything was setup for new users. Finally, I added VSCode build/test tasks and debug targets. If people use the dev container, it takes running one command in VSCode and hitting F5 before they are running the code for the first time, which is pretty nice. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2026-04-25 00:15:40 +02:00
adam closed this issue 2026-04-25 00:15:40 +02:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/audiobookshelf#3443