Skip to content

Commit

Permalink
Polish docs (#103)
Browse files Browse the repository at this point in the history 
* wip

* wip

* docs polishing

* Update release notes and handle v in tag name

---------

Co-authored-by: Kumaran Rajendhiran <[email protected]>
  • Loading branch information
@davorrunje @kumaranvpl
davorrunje and kumaranvpl authored Sep 4, 2024
1 parent 8242c7c commit 70043d4
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 2 deletions.
46 changes: 46 additions & 0 deletions docs/docs/en/release.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,52 @@ hide:
---

# Release Notes
## v0.0.0dev1

### What's Changed
* Sync wasp 0.14 by [@davorrunje](https://github.com/davorrunje){.external-link target="_blank"} in [#2](https://github.com/airtai/fastagency/pull/2){.external-link target="_blank"}
* Update together model string by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#3](https://github.com/airtai/fastagency/pull/3){.external-link target="_blank"}
* Fix together model string by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#4](https://github.com/airtai/fastagency/pull/4){.external-link target="_blank"}
* Update together model string by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#5](https://github.com/airtai/fastagency/pull/5){.external-link target="_blank"}
* Update together model string by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#7](https://github.com/airtai/fastagency/pull/7){.external-link target="_blank"}
* Update together model string by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#8](https://github.com/airtai/fastagency/pull/8){.external-link target="_blank"}
* Update togetherai model string by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#14](https://github.com/airtai/fastagency/pull/14){.external-link target="_blank"}
* Add prisma protocol class by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#6](https://github.com/airtai/fastagency/pull/6){.external-link target="_blank"}
* Fix wrong package ecosystem in dependabot config by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#23](https://github.com/airtai/fastagency/pull/23){.external-link target="_blank"}
* Update package versions by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#34](https://github.com/airtai/fastagency/pull/34){.external-link target="_blank"}
* Remove auth callout by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#36](https://github.com/airtai/fastagency/pull/36){.external-link target="_blank"}
* Update package versions by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#45](https://github.com/airtai/fastagency/pull/45){.external-link target="_blank"}
* Update docs link in workflow by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#46](https://github.com/airtai/fastagency/pull/46){.external-link target="_blank"}
* Import ContextRepo defined in faststream_lifespan by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#49](https://github.com/airtai/fastagency/pull/49){.external-link target="_blank"}
* Rename repo by [@davorrunje](https://github.com/davorrunje){.external-link target="_blank"} in [#50](https://github.com/airtai/fastagency/pull/50){.external-link target="_blank"}
* Add a file to LFS by [@davorrunje](https://github.com/davorrunje){.external-link target="_blank"} in [#56](https://github.com/airtai/fastagency/pull/56){.external-link target="_blank"}
* packages updated by [@davorrunje](https://github.com/davorrunje){.external-link target="_blank"} in [#57](https://github.com/airtai/fastagency/pull/57){.external-link target="_blank"}
* Studio related files moved to submodule by [@davorrunje](https://github.com/davorrunje){.external-link target="_blank"} in [#58](https://github.com/airtai/fastagency/pull/58){.external-link target="_blank"}
* The properties title should be consistent and follow a standardized format by [@harishmohanraj](https://github.com/harishmohanraj){.external-link target="_blank"} in [#66](https://github.com/airtai/fastagency/pull/66){.external-link target="_blank"}
* The baseurl is wrong for azure llm by [@harishmohanraj](https://github.com/harishmohanraj){.external-link target="_blank"} in [#72](https://github.com/airtai/fastagency/pull/72){.external-link target="_blank"}
* Update package versions by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#76](https://github.com/airtai/fastagency/pull/76){.external-link target="_blank"}
* Update azure base url error msg by [@harishmohanraj](https://github.com/harishmohanraj){.external-link target="_blank"} in [#77](https://github.com/airtai/fastagency/pull/77){.external-link target="_blank"}
* Add title to the base url field by [@harishmohanraj](https://github.com/harishmohanraj){.external-link target="_blank"} in [#79](https://github.com/airtai/fastagency/pull/79){.external-link target="_blank"}
* Remove wasp by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#75](https://github.com/airtai/fastagency/pull/75){.external-link target="_blank"}
* Add missing LICENSE, code of conduct and rename twitter.com to x.com by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#82](https://github.com/airtai/fastagency/pull/82){.external-link target="_blank"}
* Support new openai api key validation by [@harishmohanraj](https://github.com/harishmohanraj){.external-link target="_blank"} in [#83](https://github.com/airtai/fastagency/pull/83){.external-link target="_blank"}
* Fix docs build by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#84](https://github.com/airtai/fastagency/pull/84){.external-link target="_blank"}
* Unable to update an existing secret name by [@harishmohanraj](https://github.com/harishmohanraj){.external-link target="_blank"} in [#85](https://github.com/airtai/fastagency/pull/85){.external-link target="_blank"}
* Fix togetherai tests by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#86](https://github.com/airtai/fastagency/pull/86){.external-link target="_blank"}
* Docs branding by [@harishmohanraj](https://github.com/harishmohanraj){.external-link target="_blank"} in [#88](https://github.com/airtai/fastagency/pull/88){.external-link target="_blank"}
* Update library versions by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#95](https://github.com/airtai/fastagency/pull/95){.external-link target="_blank"}
* Introduces core classes and a CLI command for running FastAgency by [@davorrunje](https://github.com/davorrunje){.external-link target="_blank"} in [#98](https://github.com/airtai/fastagency/pull/98){.external-link target="_blank"}
* Update together tests by [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} in [#99](https://github.com/airtai/fastagency/pull/99){.external-link target="_blank"}
* Docs rebranding by [@harishmohanraj](https://github.com/harishmohanraj){.external-link target="_blank"} in [#101](https://github.com/airtai/fastagency/pull/101){.external-link target="_blank"}
* Polish docs by [@davorrunje](https://github.com/davorrunje){.external-link target="_blank"} in [#102](https://github.com/airtai/fastagency/pull/102){.external-link target="_blank"}

### New Contributors
* [@davorrunje](https://github.com/davorrunje){.external-link target="_blank"} made their first contribution in [#2](https://github.com/airtai/fastagency/pull/2){.external-link target="_blank"}
* [@kumaranvpl](https://github.com/kumaranvpl){.external-link target="_blank"} made their first contribution in [#3](https://github.com/airtai/fastagency/pull/3){.external-link target="_blank"}
* [@harishmohanraj](https://github.com/harishmohanraj){.external-link target="_blank"} made their first contribution in [#66](https://github.com/airtai/fastagency/pull/66){.external-link target="_blank"}

**Full Changelog**: [#v0.0.0dev1](https://github.com/airtai/fastagency/commits/v0.0.0dev1){.external-link target="_blank"}

## 0.0.0dev0

**Full Changelog**: [#0.0.0dev0](https://github.com/airtai/fastagency/commits/0.0.0dev0){.external-link target="_blank"}
Expand Down
6 changes: 4 additions & 2 deletions docs/update_releases.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def _convert_links_and_usernames(text):


def _collect_already_published_versions(text: str) -> List[str]:
data: List[str] = re.findall(r"## (\d.\d.\d.*)", text)
data: List[str] = re.findall(r"## [v]?(\d.\d.\d.*)", text)
return data


Expand All @@ -74,7 +74,9 @@ def update_release_notes(realease_notes_path: Path) -> None:
old_versions = _collect_already_published_versions(changelog)

for version, body in filter(
lambda v: v[0] not in old_versions,
lambda v: v[0] not in old_versions
if "v" not in v[0]
else v[0][1:] not in old_versions,
_get_github_releases(),
):
body = body.replace("##", "###")
Expand Down

0 comments on commit 70043d4

Please sign in to comment.