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

improve docs structure for V4 #5586

Merged
merged 128 commits into from
Nov 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
128 commits
Select commit Hold shift + click to select a range
4a1dbb5
improve docs structure for V4
DidierRLopes Oct 20, 2023
1ce74c2
moving over changes
andrewkenreich Oct 20, 2023
33993c2
Add Docs to the navbar
DidierRLopes Oct 21, 2023
86849d3
add some, re-order sidebar
deeleeramone Oct 21, 2023
1d78b1b
fix sentence
deeleeramone Oct 21, 2023
c452c9e
add docs install to source instructions
deeleeramone Oct 21, 2023
6a99493
insert a couple of links, fix a typo
deeleeramone Oct 23, 2023
6b354db
big terminal docs usage revamps
DidierRLopes Oct 25, 2023
cb72276
improve toggle component for tutorials
DidierRLopes Oct 26, 2023
ed40219
get rid of TOCs for all terminal docs for consistency and simplicity
DidierRLopes Oct 26, 2023
8667a5b
improve platform docs
DidierRLopes Oct 26, 2023
1717e62
improve bot docs content structure
DidierRLopes Oct 26, 2023
52c9d6e
remove index from bot docs
DidierRLopes Oct 26, 2023
2a244a0
improve ON THIS PAGE to only display TOC if at least 1 element
DidierRLopes Oct 26, 2023
79bae79
make edit this page text and icon on same line
DidierRLopes Oct 26, 2023
6edec26
add author and date to docs
DidierRLopes Oct 26, 2023
1c26463
add basic syntax page to usage
deeleeramone Oct 26, 2023
48044c3
sidebar order for usage section
deeleeramone Oct 26, 2023
7d80a4d
move api start command to the top with the import python import
deeleeramone Oct 26, 2023
d95e4a0
Merge branch 'feature/openbb-sdk-v4' into feature/improve-sdk-v4-docs…
hjoaquim Oct 27, 2023
7648083
some install page additions
deeleeramone Oct 27, 2023
0c56f80
small improvement
DidierRLopes Oct 28, 2023
c7e0cee
refactor routines section
DidierRLopes Oct 28, 2023
93d221b
Update introduction-to-routines.md
DidierRLopes Oct 28, 2023
f32151a
Update pipeline-of-commands.md
DidierRLopes Oct 28, 2023
da2a737
Update introduction-to-routines.md
DidierRLopes Oct 28, 2023
ca0fc5a
Update routines-for-power-users.md
DidierRLopes Oct 28, 2023
d3f91dd
Update community-routines.md
DidierRLopes Oct 28, 2023
c98dca2
update keyboard hotkey macros
DidierRLopes Oct 28, 2023
e141624
askobb page
DidierRLopes Oct 28, 2023
7b782fd
Update askobb-feature.md
DidierRLopes Oct 28, 2023
69e5cb8
Update index.md
DidierRLopes Oct 28, 2023
e97619a
Update index.md
DidierRLopes Oct 28, 2023
3f4ea79
Update index.md
DidierRLopes Oct 28, 2023
989f690
Update index.md
DidierRLopes Oct 28, 2023
5806855
fix images
DidierRLopes Oct 28, 2023
3854328
remove HeadTitle from all files where it exist
DidierRLopes Oct 28, 2023
63df4e3
get rid of extra spacing in markdown
DidierRLopes Oct 28, 2023
7cc8c77
small update
DidierRLopes Oct 28, 2023
620f6ed
small edit
DidierRLopes Oct 28, 2023
8b15d7b
need index at the start because of main path when homepage of docs
DidierRLopes Oct 28, 2023
2498497
use openAI to create SEO for front matter on my behalf
DidierRLopes Oct 28, 2023
f88afa4
remove table of content from sdk page
DidierRLopes Oct 28, 2023
dcbffac
finish improving metadata SEO for SDK docs
DidierRLopes Oct 28, 2023
4f1a26f
update duplicate header
DidierRLopes Oct 28, 2023
bf87df3
update HeadTitle to be more specific on product
DidierRLopes Oct 28, 2023
8938de8
remove index from bot telegram reference
DidierRLopes Oct 28, 2023
72e7ead
delete duplicated title for platform reference
DidierRLopes Oct 28, 2023
788a090
another update
DidierRLopes Oct 29, 2023
195bc05
Hotfix/econometrics export filename fix (#5508)
ssahaxd Oct 30, 2023
d4b7d6e
FIX #5600 Updated the Twitter logo to X logo (#5601)
professssor Oct 30, 2023
31f0ed4
Change Ultima paragraph (#5624)
hjoaquim Oct 30, 2023
d7d8eaf
Update CONTRIBUTING.md (#5623)
FarukhS52 Oct 30, 2023
23ae1ea
mobile line-brake fixed (#5604)
maxxsh Oct 30, 2023
e380382
start PR so screenshots can get attached via GitHub website
deeleeramone Oct 30, 2023
dde1dd9
Update qa.md
deeleeramone Oct 30, 2023
4ad995f
Docs/terminalpro and improvement (#5622)
DidierRLopes Oct 30, 2023
b9c70ec
Add light blue banner, blue when clicking sidebar + fix link in docus…
DidierRLopes Oct 30, 2023
43fbc80
Update crypto introduction.md
deeleeramone Oct 30, 2023
e8e7828
titles
deeleeramone Oct 30, 2023
a2403ec
another title
deeleeramone Oct 30, 2023
bceed7d
Update crypto dd.md
deeleeramone Oct 31, 2023
8ac07a3
Update defi.md
deeleeramone Oct 31, 2023
46d943f
Update disc.md
deeleeramone Oct 31, 2023
b2c5ea0
Update nft.md
deeleeramone Oct 31, 2023
3028c38
Update onchain.md
deeleeramone Oct 31, 2023
c9be363
Update ov.md
deeleeramone Oct 31, 2023
99ca283
Update introduction.md
deeleeramone Oct 31, 2023
ef517f2
Update introduction.md
deeleeramone Oct 31, 2023
7ecde8e
Update ba.md
deeleeramone Oct 31, 2023
f298b91
Update comparison.md
deeleeramone Nov 1, 2023
7662548
Update dark-pool-shorts.md
deeleeramone Nov 1, 2023
485f677
Update disc.md
deeleeramone Nov 1, 2023
478fd5e
fix docs (#5646)
andrewkenreich Nov 1, 2023
31bdf13
Update fa.md
deeleeramone Nov 1, 2023
51f7a01
Update gov.md
deeleeramone Nov 1, 2023
3186202
Update ins.md
deeleeramone Nov 1, 2023
1514be0
Update tradinghours.md
deeleeramone Nov 1, 2023
9840902
Delete website/content/terminal/menus/stocks/options/screener.md
deeleeramone Nov 2, 2023
22b0083
Update Options introduction.md
deeleeramone Nov 2, 2023
99ac3dd
Update screener head title
deeleeramone Nov 2, 2023
91b16cc
Update screener TOC
deeleeramone Nov 2, 2023
654e19a
Update econometrics.md
deeleeramone Nov 2, 2023
1b468db
Update economy head title
deeleeramone Nov 2, 2023
5c47f66
Update etf.md
deeleeramone Nov 3, 2023
e305f71
codespell
deeleeramone Nov 3, 2023
1386cbb
Fix the redirect for intro to the correct url for docs (#5658)
fadilparves Nov 3, 2023
9f3fcd3
Contributing guidelines (#5615)
hjoaquim Nov 3, 2023
51b4400
Merge branch 'feature/improve-sdk-v4-docs-struct' of https://github.c…
deeleeramone Nov 3, 2023
bad7d95
collapse options subfolder
deeleeramone Nov 3, 2023
cdc416e
codespell
deeleeramone Nov 3, 2023
504a4f4
Improve Pro documentation further (#5641)
DidierRLopes Nov 3, 2023
80efde4
Update folders.md
DidierRLopes Nov 3, 2023
90eb092
Update integrate-your-own-backend.md
DidierRLopes Nov 3, 2023
454bd10
Update index.md
DidierRLopes Nov 3, 2023
e5aad53
Update fixedincome.md
deeleeramone Nov 3, 2023
8470064
url
deeleeramone Nov 3, 2023
7138cc5
Update forecast.md
deeleeramone Nov 3, 2023
c10301f
Update settings.md (#5665)
DidierRLopes Nov 3, 2023
b825697
Update forex.md
deeleeramone Nov 3, 2023
04f0a63
fix front matter (#5667)
DidierRLopes Nov 3, 2023
dad6ffc
Merge branch 'develop' into temp/docs
piiq Nov 5, 2023
b68cf23
Sync new doc branches with develop
piiq Nov 5, 2023
5d1f0df
Fix conflict markers that got into markdown during previous merges
piiq Nov 5, 2023
d200d9b
Fix front matter list formatting
piiq Nov 5, 2023
bd40ad9
Fix typo
piiq Nov 5, 2023
cf41ce7
small typos
DidierRLopes Nov 5, 2023
43285b8
small thing
DidierRLopes Nov 5, 2023
099dd53
merge with openbb-sdk-v4
DidierRLopes Nov 5, 2023
cf37f2c
fix hyperlinks
DidierRLopes Nov 5, 2023
4204df1
Update .codespell.ignore
DidierRLopes Nov 5, 2023
0b83600
output_type options
hjoaquim Nov 6, 2023
8d9edb7
Architectural considerations
hjoaquim Nov 6, 2023
8dd8c37
Update sidebar to hide pro section by default
piiq Nov 6, 2023
3c5e412
Minor copy changes
piiq Nov 6, 2023
a50c440
TET pattern
hjoaquim Nov 6, 2023
cc1b5a9
import statements
hjoaquim Nov 6, 2023
732e3f5
clarification on preferences
hjoaquim Nov 6, 2023
4d26102
Merge branch 'feature/improve-sdk-v4-docs-struct' of github.com:OpenB…
hjoaquim Nov 6, 2023
34098e7
Minor copy changes
piiq Nov 6, 2023
c485396
Lint markdown and python
piiq Nov 6, 2023
8658209
fix: open index on collapsible root elements
jose-donato Nov 6, 2023
2ebcd2a
remove old content
deeleeramone Nov 6, 2023
ba0cb03
options title
deeleeramone Nov 6, 2023
9d93e0a
Fix linting errors
piiq Nov 6, 2023
528b1ec
Merge remote-tracking branch 'upstream/feature/improve-sdk-v4-docs-st…
piiq Nov 6, 2023
81a8a78
Refactor sidebar label to url mapping condition
piiq Nov 6, 2023
672a4a7
Merge branch 'feature/openbb-sdk-v4' into feature/improve-sdk-v4-docs…
piiq Nov 6, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
1 change: 1 addition & 0 deletions .codespell.ignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
ake
alle
ba
brin
buda
Expand Down
3 changes: 2 additions & 1 deletion .secrets.baseline
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,8 @@
{
"path": "detect_secrets.filters.regex.should_exclude_secret",
"pattern": [
"example"
"example",
"REPLACE_ME"
]
}
],
Expand Down
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ Now that we have added the model function getting, we need to specify that this

If you are adding a new function with a new data source, make a new value in the file. If the data source requires an
API key, please refer to the guide below for adding them. Instructions for obtaining the new api key
should be included in the file `OpenBBTerminal/website/content/terminal/usage/guides/api-keys.md`.
should be included in the file `OpenBBTerminal/website/content/terminal/usage/data/api-keys.md`.

### View

Expand Down Expand Up @@ -529,7 +529,7 @@ Any new features that do not contain unit tests will not be accepted.

### Open a Pull Request

For starters, you should ensure that you branch is up to date with the `develop` branch. To do that, one can run the following commands:
For starters, you should ensure that your branch is up to date with the `develop` branch. To do that, one can run the following commands:

```bash
git fetch upstream
Expand Down Expand Up @@ -587,7 +587,7 @@ CLI :computer: → `_controller.py` :robot: → `_view.py` :art:  &nbs
| **Item** | **Description** | **Example** |
| :----------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------- |
| **CONTEXT** | Specific instrument _world_ to analyse. | `stocks`, `crypto`, `economy` |
| **CATEGORY** | Group of similar COMMANDS to do on the instrument <br /> There are the specialized categories, specific to each CONTEXT and there are common categories which are not specific to one CONTEXT. | `due_diligence`, `technical_analysis`, `insider` |
| **CATEGORY** | Group of similar COMMANDS to do on the instrument <br /> There are specialized categories, specific to each CONTEXT and there are common categories which are not specific to one CONTEXT. | `due_diligence`, `technical_analysis`, `insider` |
| **COMMAND** | Operation on one or no instrument that retrieves data in form of string, table or plot. | `rating`, `supplier`, `sentiment` |

The following layout is expected: `/<context>/<category>/<command_files>`
Expand Down Expand Up @@ -630,7 +630,7 @@ With:

1. Each function should have default values for non critical kwargs

- Why? It increases code readability and acts as an input example for the functions arguments. This increases the ease of use of the functions through the SDK, but also just generally.
- Why? It increases code readability and acts as an input example for the function's arguments. This increases the ease of use of the functions through the SDK, but also just generally.

> Watch out, add default values whenever possible, but take care for not adding mutable default arguments! [More info](https://docs.python-guide.org/writing/gotchas/#mutable-default-arguments)

Expand Down Expand Up @@ -706,7 +706,7 @@ With:

3. Each function needs to have a docstring explaining what it does, its parameters and what it returns.

- Why? You can use the function without reading its source code. This improves the developing experience and SDK usage. The SDK factory also can’t handle functions with out docstrings.
- Why? You can use the function without reading its source code. This improves the developing experience and SDK usage. The SDK factory also can’t handle functions without docstrings.

<br>

Expand Down Expand Up @@ -1404,12 +1404,12 @@ In the `_view.py` files it is common having at the end of each function `export_
Let's go into each of these arguments:

- `export` corresponds to the type of file we are exporting.
- If the user doesn't has anything selected, then this function doesn't do anything.
- If the user doesn't have anything selected, then this function doesn't do anything.
- The user can export multiple files and even name the files.
- The allowed type of files `json,csv,xlsx` for raw data and `jpg,pdf,png,svg` for figures depends on the `export_allowed` variable defined in `parse_known_args_and_warn`.
- `os.path.dirname(os.path.abspath(__file__))` corresponds to the directory path
- This is important when `export folder` selected is the default because the data gets stored based on where it is called.
- If this is called from a `common` folder, we can use `os.path.dirname(os.path.abspath(__file__)).replace("common", "stocks")` insteaad
- If this is called from a `common` folder, we can use `os.path.dirname(os.path.abspath(__file__)).replace("common", "stocks")` instead
- `"pt"` corresponds to the name of the exported file (+ unique datetime) if the user doesn't provide one
- `df_analyst_data` corresponds to the dataframe with data.
- `sheet_name` corresponds to the name of the sheet in the excel file.
Expand Down Expand Up @@ -1528,7 +1528,7 @@ class ForexController(BaseController):

In case the user is interested in a **DYNAMIC** list of options which changes based on user's state, then a class method must be defined.

The example below shows the an excerpt from `update_runtime_choices` method in the [`options` controller](/openbb_terminal/stocks/options/options_controller.py).
The example below shows an excerpt from `update_runtime_choices` method in the [`options` controller](/openbb_terminal/stocks/options/options_controller.py).

```python
def update_runtime_choices(self):
Expand Down Expand Up @@ -1559,8 +1559,8 @@ This is storing every logged message inside the following location :

Where $HOME is the user home directory, for instance:

- `C:\Users\foo` if your are in Windows and your name is foo
- `/home/bar/` if you are is macOS or Linux and your name is bar
- `C:\Users\foo` if you are in Windows and your name is foo
- `/home/bar/` if you are in macOS or Linux and your name is bar

The user can override this location using the settings key `OPENBB_USER_DATA_DIRECTORY`.

Expand Down Expand Up @@ -1615,7 +1615,7 @@ becomes
stocks/NEWS: mais recentes notícias da empresa
```

Note: To speed up translation, the team developed a [script](/i18n/help_translation.ipynb) that uses Google translator API to help translating the entire `en.yml` document to the language of choice. Then the output still needs to be reviewed, but this can be an useful bootstrap.
Note: To speed up translation, the team developed a [script](/i18n/help_translation.ipynb) that uses Google translator API to help translating the entire `en.yml` document to the language of choice. Then the output still needs to be reviewed, but this can be a useful bootstrap.

This is the convention in use for creating a new key/value pair:

Expand Down
4 changes: 2 additions & 2 deletions examples/googleColabInstallation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1852,7 +1852,7 @@
"cell_type": "code",
"source": [
"# The source for the data can be defined by using the `source` argument.\n",
"# Instructions for obtaining and entering API keys are found here: https://docs.openbb.co/sdk/usage/guides/api-keys\n",
"# Instructions for obtaining and entering API keys are found here: https://docs.openbb.co/sdk/usage/api-keys\n",
"\n",
"balance_sheet_growth = openbb.stocks.fa.balance(symbol, ratios = True).transpose()\n",
"\n",
Expand Down Expand Up @@ -2488,4 +2488,4 @@
]
}
]
}
}
Loading
Loading