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

[docs] Reorder README #475

Closed
nemesifier opened this issue Jun 1, 2021 · 0 comments · Fixed by #627
Closed

[docs] Reorder README #475

nemesifier opened this issue Jun 1, 2021 · 0 comments · Fixed by #627
Assignees
@nemesifier
Labels
enhancement Important Higher priority or release blocker
Milestone
1.0.0 Release (Op...

Comments

@nemesifier
Copy link
Member

nemesifier commented Jun 1, 2021 •
edited
Loading

Some README sections look a bit randomly ordered, I'll reorder them to ensure subjects are grouped under dedicated sections, so it will be also easier to turn these sections into dedicated pages on the future comprehensive documentation (openwisp/openwisp-docs#107).

To be done after #421.

Here's other notes I have taken while reviewing the README:

  • feature overview should be shown earlier
  • feature overview should link the template docs page, should mention default and required templates
  • REST API should be mentioned in the feature overview
  • geo API endpoints should be moved to REST API section
@nemesifier nemesifier self-assigned this Jun 1, 2021
@nemesifier nemesifier added the Important Higher priority or release blocker label Aug 6, 2021
@nemesifier nemesifier added this to the 1.0.0 milestone Apr 4, 2022
nemesifier added a commit that referenced this issue Apr 11, 2022
@nemesifier
[docs] Re-ordered and improved README #475
91d11fd 
Closes #475
nemesifier added a commit that referenced this issue Apr 11, 2022
@nemesifier
[docs] Re-ordered and improved README #475
e0fc362 
Closes #475
@nemesifier nemesifier mentioned this issue Apr 11, 2022
Merged
nemesifier added a commit that referenced this issue Apr 12, 2022
@nemesifier
[docs] Re-ordered and improved README #475
75d7ed1 
Closes #475
codesankalp pushed a commit that referenced this issue Apr 21, 2022
@nemesifier @codesankalp
[docs] Re-ordered and improved README #475
1adedfc 
Closes #475
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nemesifier nemesifier

Labels
enhancement Important Higher priority or release blocker
Projects
OpenWISP Priorities for next releases
Archived in project
Milestone
1.0.0 Release (OpenWISP 22.05)
Development

Successfully merging a pull request may close this issue.

[docs] Re-ordered and improved README #475 openwisp/openwisp-controller
1 participant
@nemesifier