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

Initial Documentation Content #346

Merged
merged 26 commits into from
Aug 14, 2024
Merged

Initial Documentation Content #346

merged 26 commits into from
Aug 14, 2024

Conversation

wilwade
Copy link
Contributor

@wilwade wilwade commented Aug 6, 2024

This is the first pile of the documentation content.

Testing

cd docs
mdbook serve
open http://localhost:3000

Closes Docs issues:

Closes embed issues:

@wilwade wilwade requested a review from p5150j August 6, 2024 20:25
@wilwade wilwade changed the title Update Docs Initial Documentation Content Aug 13, 2024
@@ -40,7 +40,6 @@ flowchart LR;
GS[Graph Service]
CPS[Content Publishing Service]
CWS[Content Watcher Service]
RS[Graph Reconnection Service]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing reconnection service for now

@@ -0,0 +1,60 @@
/* Button Links */
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Button Link support

This application recognizes the following environment variables:

| Name | Description | Range/Type | Required? | Default |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Formatted and sorted

This application recognizes the following environment variables:

| Name | Description | Range/Type | Required? | Default |
| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------: | :-------: | :-------------------------: |
| `API_PORT` | HTTP port that the application listens on | 1025 - 65535 | | 3000 |
| `CACHE_KEY_PREFIX` | Prefix to use for Redis cache keys | string | | content-publishing-service: |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Formatted and sorted

This application recognizes the following environment variables:

| Name | Description | Range/Type | Required? | Default |
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------: | :-------: | :--------------: | --- | --- | --- | --- |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed a typo, formatted, and sorted.

Copy link
Contributor

@mattheworris mattheworris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!

@JoeCap08055 JoeCap08055 merged commit 0d76a4e into main Aug 14, 2024
7 of 11 checks passed
@JoeCap08055 JoeCap08055 deleted the chore-update-docs branch August 14, 2024 18:14
Copy link

@wesbiggs wesbiggs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't been through all of it but here are some suggestions.

docs/src/README.md Show resolved Hide resolved
docs/src/README.md Show resolved Hide resolved
docs/src/README.md Show resolved Hide resolved
Account Service is a service enabling easy interaction with accounts on Frequency.
Accounts are be defined as an `msaId` (a 64 bit identifier) and can contain additional information such as a handle, keys, and more.

- Account creation using [SIWF](https://github.com/ProjectLibertyLabs/siwf)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it also for authentication?

docs/src/README.md Show resolved Hide resolved
docs/src/README.md Show resolved Hide resolved
docs/src/Fundamentals/README.md Show resolved Hide resolved
docs/src/Fundamentals/README.md Show resolved Hide resolved
docs/src/Fundamentals/README.md Show resolved Hide resolved
```

```sh
cd social-web-template

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo, should be social-app-template

wilwade added a commit that referenced this pull request Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants