Skip to content

Update ReadMe #7

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

Merged
merged 5 commits into from
Apr 16, 2023
Merged

Update ReadMe #7

merged 5 commits into from
Apr 16, 2023

Conversation

ayutaz
Copy link
Contributor

@ayutaz ayutaz commented Apr 16, 2023

feat

  • JP,ENのReadMeの作成および更新
  • 目次の自動生成のactionsの追加

@ayutaz ayutaz requested a review from eiei114 April 16, 2023 09:34
@cr-gpt
Copy link

cr-gpt bot commented Apr 16, 2023

Seems you are using me but didn't get OPENAI_API_KEY seted in Variables for this repo. you could follow readme for more information

1 similar comment
@cr-gpt
Copy link

cr-gpt bot commented Apr 16, 2023

Seems you are using me but didn't get OPENAI_API_KEY seted in Variables for this repo. you could follow readme for more information

@ayutaz ayutaz force-pushed the docs/update_readme branch from da9d594 to 7ae303f Compare April 16, 2023 09:44
@ayutaz ayutaz marked this pull request as ready for review April 16, 2023 09:44
# Setup
1. obtain the NotionAPI token and the Id of the Notion DB you wish to reflect
2. set the NotionAPI token to the environment variable of GitHub Actions
Fork Repository and change `publication_url` in `main.py` to your Publication's URL No newline at end of file

Choose a reason for hiding this comment

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

Overall, the code patch seems to be focused on adding documentation rather than making changes to the code itself. However, there are a couple of things worth noting:

  • The remaining tasks in the schedule section of the code should probably be moved to an issue tracker or project management tool.
  • It might be useful to add more detailed instructions on how to obtain the Notion API token and DB ID, as well as how to set the API token as an environment variable in GitHub Actions.

Other than that, as this is just a description of the code change and not the full code itself, it's hard to provide more specific feedback on anything that might need improvement or fixing.

# セットアップ
1. NotionAPIのトークンおよび反映させたいNotion DBのIdを取得する
2. NotionAPIのトークンをGitHub Actionsの環境変数に設定する
3. Repositoryをforkして、`main.py`の `publication_url` を自分のPublicationのURLに書き換える No newline at end of file

Choose a reason for hiding this comment

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

The code patch seems to be a README file for a tool that aggregates article titles, links, and authors from Zenn Publication and adds them to a database on Notion. Since this is not actual code, there are no bug risks or improvement suggestions to be made. However, some suggestions for improvement to the README content could include providing more details about the setup process and potentially adding examples of usage beyond the image included in the demo section.

@eiei114 eiei114 merged commit ef8cb63 into main Apr 16, 2023
@eiei114 eiei114 deleted the docs/update_readme branch April 16, 2023 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants