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

refactor(/docs): rework documentation structure layout #179

Merged
merged 12 commits into from
Jul 9, 2023
Merged

Conversation

piyoki
Copy link
Contributor

@piyoki piyoki commented Jul 7, 2023

Background

Refactor documentation structure to make sync easier.

Preview: https://github.com/daeuniverse/dae/tree/docs_refactor/docs

Checklist

Full changelogs

  • refactor(/docs): rework documentation structure layout
  • refactor(/docs): update file reference paths
  • feat(/docs): add English version of other-proxy-protocol.md
  • refacotr: move docs/templates/ docs/sync/ to hack/
  • fix(example.dae|readme): update ref link to adopt new file structure
  • refactor: rename other-proxy-protocol.md -> proxy-protocols.md
  • docs(readme): add ref to proxy-protocols.md
  • feat(/docs): add English version of how-it-works.md
  • refactor: rename how-it-works; add nav links

Issue reference

https://github.com/daeuniverse/dae-docs/issues/34

@piyoki piyoki requested a review from a team as a code owner July 7, 2023 12:11
@piyoki piyoki self-assigned this Jul 7, 2023
@piyoki piyoki requested a review from mzz2017 as a code owner July 7, 2023 12:11
@piyoki piyoki added documentation Improvements or additions to documentation and removed not-yet-tested labels Jul 7, 2023
@piyoki piyoki marked this pull request as draft July 7, 2023 12:14
@dae-prow
Copy link
Contributor

dae-prow bot commented Jul 9, 2023

❌ Your branch is currently out-of-sync to main. No worry, I will fix it for you.

@piyoki piyoki marked this pull request as ready for review July 9, 2023 05:39
@piyoki
Copy link
Contributor Author

piyoki commented Jul 9, 2023

Reference links are working fine as expected. Good job! @earrmouth

@dae-prow
Copy link
Contributor

dae-prow bot commented Jul 9, 2023

❌ Your branch is currently out-of-sync to main. No worry, I will fix it for you.

@mzz2017
Copy link
Contributor

mzz2017 commented Jul 9, 2023

Please do some work on /example.dae and /README.md, thanks.

@dae-prow
Copy link
Contributor

dae-prow bot commented Jul 9, 2023

❌ Your branch is currently out-of-sync to main. No worry, I will fix it for you.

@piyoki
Copy link
Contributor Author

piyoki commented Jul 9, 2023

Please do some work on /example.dae and /README.md, thanks.

What work are you referring to?

@mzz2017
Copy link
Contributor

mzz2017 commented Jul 9, 2023

image

@dae-prow
Copy link
Contributor

dae-prow bot commented Jul 9, 2023

❌ Your branch is currently out-of-sync to main. No worry, I will fix it for you.

@piyoki
Copy link
Contributor Author

piyoki commented Jul 9, 2023

image

Resolved in 9576193

README.md Outdated Show resolved Hide resolved
@dae-prow
Copy link
Contributor

dae-prow bot commented Jul 9, 2023

❌ Your branch is currently out-of-sync to main. No worry, I will fix it for you.

@dae-prow
Copy link
Contributor

dae-prow bot commented Jul 9, 2023

❌ Your branch is currently out-of-sync to main. No worry, I will fix it for you.

@piyoki piyoki requested a review from mzz2017 July 9, 2023 08:35
@piyoki piyoki requested a review from earrmouth July 9, 2023 08:35
@dae-prow
Copy link
Contributor

dae-prow bot commented Jul 9, 2023

❌ Your branch is currently out-of-sync to main. No worry, I will fix it for you.

@dae-prow
Copy link
Contributor

dae-prow bot commented Jul 9, 2023

❌ Your branch is currently out-of-sync to main. No worry, I will fix it for you.

@piyoki
Copy link
Contributor Author

piyoki commented Jul 9, 2023

The required check has been passed. Ready for review

@piyoki piyoki merged commit e39ec7f into main Jul 9, 2023
@piyoki piyoki deleted the docs_refactor branch July 9, 2023 09:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants