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.

Sign up for GitHub

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

Jump to bottom

Consolidate documentation on the website #940

Closed
kamadorueda opened this issue Sep 26, 2022 · 1 comment
Closed

Consolidate documentation on the website #940

kamadorueda opened this issue Sep 26, 2022 · 1 comment
Assignees
@dsalaza4
Labels
help wanted Will be solved only if someone contributes it

Comments

@kamadorueda
Copy link
Contributor

The website is nice, it's well structured, has a search bar, and is generally easier to navigate than the long readme we currently have, it's also easier to point someone to a specific part of the documentation on the web than in the readme, and it's also easier to locate content, as the table of contents is to the side instead of to the top
@kamadorueda kamadorueda moved this to 🆕 New in Makes Roadmap Sep 26, 2022
@kamadorueda kamadorueda moved this from 🆕 New to 📋 To do in Makes Roadmap Sep 26, 2022
@kamadorueda kamadorueda added the help wanted Will be solved only if someone contributes it label Oct 4, 2022
@kamadorueda kamadorueda removed their assignment Oct 4, 2022
@dsalaza4 dsalaza4 self-assigned this Mar 8, 2023
@dsalaza4
Copy link
Contributor

dsalaza4 commented Mar 8, 2023 •
edited
Loading

I will prioritize this as I think that having a simple-as-possible readme will:

  1. Considerably increase adoption.
  2. Align Makes with our philosophies of learn as you do and microchanges.

dsalaza4 added a commit that referenced this issue Mar 8, 2023
@dsalaza4
Merge pull request #1019 from dsalaza4/main
b3d03bf 
feat(build): #940 use mkdocs
github-actions bot added a commit that referenced this issue Mar 8, 2023
@github-actions
Merge pull request #1019 from dsalaza4/main
89bd1fb 
feat(build): #940 use mkdocs
dsalaza4 added a commit that referenced this issue Mar 8, 2023
@dsalaza4
Merge pull request #1021 from dsalaza4/main
8afbd21 
feat(build): #940 mkdocs gh-deploy
dsalaza4 added a commit that referenced this issue Mar 8, 2023
@dsalaza4
Merge pull request #1022 from dsalaza4/main
16813d7 
feat(build): #940 set remote branch
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 8, 2023
@dsalaza4
feat(build): fluidattacks#940 use default branch
303973b 
- As envs get automatically created
- Forks can now create their own github pages
by running the deploy job

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 8, 2023
@dsalaza4
Merge pull request #1023 from dsalaza4/main
1ab06a4 
feat(build): #940 use default branch
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 8, 2023
@dsalaza4
feat(doc): fluidattacks#940 move sections
64e623d 
- Move several sections to new docs page
- Other minor changes

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 8, 2023
@dsalaza4
feat(doc): fluidattacks#940 move sections
09491fe 
- Move several sections to new docs page
- Other minor changes

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 8, 2023
@dsalaza4
Merge pull request #1024 from dsalaza4/main
f892a4e 
feat(doc): #940 move sections
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 8, 2023
@dsalaza4
feat(doc): fluidattacks#940 makes nix reference
8ba0269 
- Migrate makes nix reference
- Considerably reduce external links for simplicity
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 8, 2023
@dsalaza4
feat(doc): fluidattacks#940 makes nix reference
2b4eda0 
- Migrate makes nix reference
- Considerably reduce external links for simplicity

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 8, 2023
@dsalaza4
Merge pull request #1025 from dsalaza4/main
1bf2764 
feat(doc): #940 makes nix reference
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 9, 2023
@dsalaza4
feat(doc): fluidattacks#940 split makes reference
ea401f8 
- For better readability
- Disable md linter rule

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 9, 2023
@dsalaza4
Merge pull request #1026 from dsalaza4/main
a678dfe 
feat(doc): #940 split makes reference
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 9, 2023
@dsalaza4
feat(doc): fluidattacks#940 doc theme
1d4068b 
- Improve doc theme
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 9, 2023
@dsalaza4
feat(doc): fluidattacks#940 doc theme
78b5510 
- Improve doc theme

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 9, 2023
@dsalaza4
feat(doc): fluidattacks#940 doc theme
4db14ae 
- Improve doc theme

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 9, 2023
@dsalaza4
Merge pull request #1027 from dsalaza4/main
97dacf4 
feat(doc): #940 doc theme
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 9, 2023
@dsalaza4
feat(doc): fluidattacks#940 extending makes
b6f58e8 
- Add extending makes to new doc
- Split it for better readability
- Other minor changes

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 9, 2023
@dsalaza4
feat(doc): fluidattacks#940 extending makes
4133893 
- Add extending makes to new doc
- Split it for better readability
- Other minor changes

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 9, 2023
@dsalaza4
Merge pull request #1028 from dsalaza4/main
40efc00 
feat(doc): #940 extending makes
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 9, 2023
@dsalaza4
feat(doc): fluidattacks#940 turn on new site
4940a0b 
- Make new docs site official
- Remove doc from README
- Leave description and goal
- Remove formatMarkdown job
as it is no longer necessary
dsalaza4 added a commit that referenced this issue Mar 10, 2023
@dsalaza4
Merge pull request #1033 from dsalaza4/main
e5a91e3 
feat(doc): #940 custom domain
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 13, 2023
@dsalaza4
feat(doc): fluidattacks#940 improve installation
9bd5556 
- Improve installation doc
- Add extra plugins
- Add external links
dsalaza4 added a commit that referenced this issue Mar 13, 2023
@dsalaza4
Merge pull request #1034 from dsalaza4/main
c159116 
feat(doc): #940 improve installation
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 13, 2023
@dsalaza4
feat(doc): fluidattacks#940 code sections
190173d 
- Add code sections to all builtins
- Use admonitions for notes and warnings
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 13, 2023
@dsalaza4
feat(doc): fluidattacks#940 code sections
3df36f2 
- Add code sections to all builtins
- Use admonitions for notes and warnings
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 13, 2023
@dsalaza4
feat(doc): fluidattacks#940 code sections
64abca7 
- Add code sections to all builtins
- Use admonitions for notes and warnings

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 13, 2023
@dsalaza4
Merge pull request #1035 from dsalaza4/main
9ea205e 
feat(doc): #940 code sections
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 13, 2023
@dsalaza4
refac(build): fluidattacks#940 rm code block rule
68d8f73 
- Remove code block rule
as it is incompatible
with admonitions

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 13, 2023
@dsalaza4
Merge pull request #1036 from dsalaza4/main
ea69ba7 
refac(build): #940 rm code block rule
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 14, 2023
@dsalaza4
feat(doc): fluidattacks#940 code sections
1f27e5a 
- Add code sections to all extensions
- Use admonitions for notes and warnings
- Add configuration for mermaid graphs

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 14, 2023
@dsalaza4
Merge pull request #1037 from dsalaza4/main
aa3dd7b 
feat(doc): #940 code sections
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 14, 2023
@dsalaza4
feat(doc): fluidattacks#940 missing admonitions
81dfe5a 
- Add missing admonitions
- Other minor changes

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 14, 2023
@dsalaza4
Merge pull request #1038 from dsalaza4/main
75b5d49 
feat(doc): #940 missing admonitions
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 14, 2023
@dsalaza4
feat(build): fluidattacks#940 push with technology
273f071 
- Push gh-pages versions with technology
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 14, 2023
@dsalaza4
feat(build): fluidattacks#940 push with technology
94bacc9 
- Push gh-pages versions with technology

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 14, 2023
@dsalaza4
Merge pull request #1039 from dsalaza4/main
4e7eaed 
feat(build): #940 push with technology
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 14, 2023
@dsalaza4
fix(build): fluidattacks#940 use right flag
7293ab5 
- Use right flag for remote

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 14, 2023
@dsalaza4
Merge pull request #1040 from dsalaza4/main
e7ae3f9 
fix(build): #940 use right flag
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 14, 2023
@dsalaza4
feat(doc): fluidattacks#940 improve examples
6b0d568 
- Improve examples in getting started section
- Simplify deploy
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 14, 2023
@dsalaza4
feat(doc): fluidattacks#940 improve examples
896e05c 
- Improve examples in getting started section
- Simplify deploy

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 14, 2023
@dsalaza4
Merge pull request #1041 from dsalaza4/main
e829267 
feat(doc): #940 improve examples
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Makes Roadmap Mar 14, 2023
@dsalaza4 dsalaza4 reopened this Mar 15, 2023
@github-project-automation github-project-automation bot moved this from ✅ Done to 📋 Backlog in Makes Roadmap Mar 15, 2023
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 15, 2023
@dsalaza4
feat(doc): fluidattacks#940 contributing title
5409ba7 
- Simplify title

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit to dsalaza4/makes that referenced this issue Mar 15, 2023
@dsalaza4
feat(doc): fluidattacks#940 contributing title
4aa559a 
- Simplify title

Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 added a commit that referenced this issue Mar 15, 2023
@dsalaza4
Merge pull request #1042 from dsalaza4/main
1960239 
feat(doc): #940 contributing title
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Makes Roadmap Mar 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dsalaza4 dsalaza4

Labels
help wanted Will be solved only if someone contributes it
Projects
Makes Roadmap
Status: ✅ Done
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dsalaza4 @kamadorueda