docs: reduce duplicate content in contributing.md (#9136)
reduce-duplicate-setup-content
This commit is contained in:
parent
78a2ff69b6
commit
b519057df7
2 changed files with 20 additions and 153 deletions
|
|
@ -162,9 +162,9 @@ At this point, you can navigate to http://localhost:3000/ in a browser and acces
|
|||
|
||||
### Build and Display Documentation
|
||||
|
||||
If you are contributing changes to documentation (always welcome!), these are built (using [Docusaurus](https://docusaurus.io/)) and served separately, also using Node.js.
|
||||
If you are contributing changes to documentation (always welcome!), these are built using [Docusaurus](https://docusaurus.io/) and served separately, also using Node.js.
|
||||
|
||||
In the *Documentation Terminal* (from the project root directory), run the following:
|
||||
In the terminal, from the project root directory, run the following:
|
||||
|
||||
```bash
|
||||
cd docs
|
||||
|
|
@ -182,11 +182,11 @@ At which point you can navigate to http://localhost:3001/ in a browser and view
|
|||
|
||||
## Adding or Modifying a Component
|
||||
|
||||
Components reside in folders under `src/backend/base/langflow`, and their unit tests under `src/backend/base/tests/unit/components`.
|
||||
Components reside in folders under `src/backend/base/langflow`, and their unit tests under `src/backend/base/tests/unit/components`.
|
||||
|
||||
### Adding a Component
|
||||
|
||||
Add the component to the appropriate subdirectory, and add the component to the `__init__.py` file (alphabetical ordering on the `import` and the `__all__` list). Assuming the backend and frontend services are running, the backend service will restart as these files are changed. The new component will be visible after the backend is restarted, _*and*_ after you hit "refresh" in the browser.
|
||||
Add the component to the appropriate subdirectory, and add the component to the `__init__.py` file (alphabetical ordering on the `import` and the `__all__` list). Assuming the backend and frontend services are running, the backend service will restart as these files are changed. The new component will be visible after the backend is restarted, _*and*_ after you hit "refresh" in the browser.
|
||||
|
||||
> [!TIP]
|
||||
> It is faster to copy-paste the component code from your editor into the UI *without* saving in the source code in the editor, and once you are satisfied it is working you can save (restarting the backend) and refresh the browser to confirm it is present.
|
||||
|
|
@ -221,7 +221,7 @@ Once you are happy your changes are complete, commit them and push the changes t
|
|||
|
||||
## Some Quirks!
|
||||
|
||||
You may observe some quirky things:
|
||||
You may observe some quirky things:
|
||||
|
||||
### Testing
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue